npm.io
0.1.0 • Published 4 years ago

mentorkit

Licence
ISC
Version
0.1.0
Deps
4
Size
47.1 MB
Vulns
23
Weekly
0
Install scriptsThis package runs scripts during installation (preinstall/install/postinstall)

Javascript/Typescript SDK for MentorKit

With the MentorKit SDK, you can easily make use of our API.

Create sessions, update rooms, get users and even be notified of events in real-time.

Documentation

View the SDK reference at https://sdk-js.mentorkit.io. It has up-to-date information on all the SDK methods.

Using Typescript? VS Code IntelliSense will guide you through all the SDK methods.

Installation

https://www.npmjs.com/package/mentorkit

npm install mentorkit

Example usage

1. Import the library
import api from "mentorkit"
2. Authenticate with API token
api.setConfig({ token })
3. Create a user
const user = await api.users.create({
    user: { email: "example@mentorkit.io" }
})
4. Add the user to a room
await api.rooms.update({
    id,
    room: {
        users: [user.id],
        name: "Mentoring room"
    },
})