CapitalOS for JavaScript

Framework-agnostic JavaScript SDK for integrating with CapitalOS

Installation

npm

npm install @capitalos/js

yarn

yarn add @capitalos/js

pnpm

pnpm add @capitalos/js

Documentation

Please refer to the official docs for more details.

Usage

In order to mount an Experience you will need to obtain a client authentication token. Refer to the CapitalOS documentation for more information.

import { createCapitalOsClient } from '@capitalos/js'

const capitalOs = createCapitalOsClient({
  getToken: async () => {
    // Call your backend which initiates login and returns a one-time token
    const res = await fetch('/api/capitalos/token', { method: 'POST' })
    const json = await res.json()
    return json.token
  },
})

const mount = capitalOs.mountCardsApp('#capitalos-cards', {
  onLoaded: () => console.log('Loaded!'),
  onError: (error) => console.error(error.code, error.message),
})

// Tear down when you're done
mount.destroy()
capitalOs.destroy()

TypeScript support

TypeScript definitions for @capitalos/js are built into the npm package and should be automatically picked up by your editor.