README.md

minis.js

TypeScript SDK to build Soapbox Minis.

Table of Contents

• Install
• API
• Building A Mini
• License

Install

$ npm install --save @soapboxsocial/minis.js

OR

$ yarn add @soapboxsocial/minis.js

---

API

Table of Contents

• getUser
• getMembers
• getRoom
• onClose
  • Parameters

getUser

Get the current user of the Mini

Returns Promise<User>

getMembers

Get all of the users in a Soapbox room

Returns Promise<Array<User>>

getRoom

Get the details of the Soapbox room

Returns Promise<Room>

onClose

Function to handle when an app is closed, can be used for app state cleanup.

Parameters

• callback Function

Building a Mini

If you want to build your own Soapbox Mini or have an idea that you'd like to run past us, send us an email.

License

MIT License © Soaper Inc.