# mentorkit

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

Latest version **0.1.0** (published 2022-01-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install mentorkit
pnpm add mentorkit
yarn add mentorkit
bun add mentorkit
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2022-01-21 |
| First published | 2022-01-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 47.1 MB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | yes |
| Maintainers | huzaifahj |

## Links

- npm: https://www.npmjs.com/package/mentorkit
- npm.io page: https://npm.io/package/mentorkit

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [typedoc](https://npm.io/package/typedoc.md) ^0.22.10
- [database](https://npm.io/package/database.md) file:./prisma-client/client1
- [typescript](https://npm.io/package/typescript.md) ^4.5.4

## Recent versions

- 0.1.0 (latest) — 2022-01-21
- 0.0.18 — 2022-01-19
- 0.0.17 — 2022-01-19
- 0.0.16 — 2022-01-19
- 0.0.15 — 2022-01-19
- 0.0.14 — 2022-01-19
- 0.0.13 — 2022-01-19
- 0.0.12 — 2022-01-19
- 0.0.11 — 2022-01-19
- 0.0.10 — 2022-01-19
- 0.0.9 — 2022-01-19
- 0.0.8 — 2022-01-19
- 0.0.7 — 2022-01-19
- 0.0.6 — 2022-01-19
- 0.0.5 — 2022-01-19
- … 4 more at https://npm.io/package/mentorkit/versions

## README

# 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

```bash
npm install mentorkit
```

## Example usage

### 1. Import the library

```ts
import api from "mentorkit"
```

### 2. Authenticate with API token

```ts
api.setConfig({ token })
```

### 3. Create a user

```ts
const user = await api.users.create({
    user: { email: "example@mentorkit.io" }
})
```

### 4. Add the user to a room

```ts
await api.rooms.update({
    id,
    room: {
        users: [user.id],
        name: "Mentoring room"
    },
})
```

---
_Source: https://npm.io/package/mentorkit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._