npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

instructure-canvas-api

v2.1.9

Published

API module to interact with canvas

Downloads

5

Readme

instructure-canvas-api

This module contains methods to make authenticated api calls to Canvas. All api calls return a promise that resolves to an AxiosResponse.

To use instructure-canvas-api you must have a session that you inform instructure-canvas-api about. Which is then used to make authenticated api calls.

import { setSession } from 'instructure-canvas-api'

setSession({
  authToken: string,
  baseURL: string,
  user: {
    primary_email: string,
    id: string,
    avatar_url: string,
    name: string,
  }
})

Later if you ever wanted to get the session you can do so using the getSession method.

import { getSession } from 'instructure-canvas-api'

let session = getSession()

The default export of instructure-canvas-api contains all of the api calls that instructure-canvas-api contains

import canvasApi from 'instructure-canvas-api'

canvasApi.refreshCourses()

Each of these api calls are also exported as named exports

import { refreshCourses } from 'instructure-canvas-api'

refreshCourses()

If you need a little more flexibility you can also import the underlying httpClient that is used to make authenticated api calls to canvas.

import { httpClient } from 'instructure-canvas-api'

let client = httpClient()

The client in this case is an axios istance that has been set up to use the auth token set in the session.

There are some utility functions that are exposed for use if needed.

import { parseNext, paginate, exhaust } from 'instructure-canvas-api/utils/pagination'
import { parseLinkHeader } from 'instructure-canvas-api/utils/parse-link-header'
import { apiResponse, apiError } from 'instructure-anvas-api/utils/testHelpers'

instructure-canvas-api comes with a default mock for jest so it's simple to mock.

jest.mock('instructure-canvas-api')

Development

If you want to work on instructure-canvas-api while seeing those changes in another app.

  • Make sure that you have the latest watchman. Can be updated through brew
  • Run yarn link in the instructure-canvas-api directory
  • run yarn link instructure-canvas-api in the project root of the app you are working on
  • run yarn start

At this point you should see the packager start and under the list of watched directorys it should show both your project root as well as the modules/instructure-canvas-api directory.

instructure-canvas-api has flow and jest tests setup

yarn flow
yarn test

Publishing

Publish to npm with gulp publish after updating the version in package.json