NorthlightSDK

App client

What an app reaches on a person's runtime: the namespaces of AppClient (runs, providers, files.download, memory, questions, uploads, attachments, shares, grant, health, usage and profiles.list).

Exports of @north-light/sdk, read from the TypeScript compiler at build time. Types re-exported from @north-light/api are documented with that package.

AppClient

type declared in client.ts

What an app reaches on a person's runtime (the app listener): Crouter without the owner-daemon namespaces, files.download only, and profiles.list only. Crouter is assignable to it, so a function that takes AppClient takes either.

Prop

Type

AppProfile

interface declared in resources/runs.ts

A profile an app may start runs with (profiles.list()). Pass profile_id as RunStartParams.profile.

Prop

Type

OwnerOnly

type declared in client.ts

The namespaces of Crouter that only the owner's own daemon serves. A person's app listener answers them 404 unknown operation.

"auth" | "bash" | "canvas" | "crons" | "customObjects" | "human" | "models" | "nodes" | "structuredRequests" | "system"

On this page