Skip to content

five-on-it / apps/client/src/ui/create / createApi

Function: createApi() ​

createApi(platform): object

Defined in: apps/client/src/ui/create.ts:191

The creation calls, as the page's session.

Parameters ​

platform ​

Platform

Returns ​

cancel ​

cancel: (id) => Promise<Creation>

Parameters ​

id ​

string

Returns ​

Promise<Creation>

jobs ​

jobs: () => Promise<Creation[]>

Returns ​

Promise<Creation[]>

models ​

models: () => Promise<CreationModels>

The models offered; none (an empty offer) where creation is off or the platform is older.

Returns ​

Promise<CreationModels>

playtest ​

playtest: (draft) => Promise<string>

Parameters ​

draft ​

string

Returns ​

Promise<string>

previewUrl ​

previewUrl: (hash) => string

Parameters ​

hash ​

string

Returns ​

string

publish ​

publish: (draft) => Promise<string>

Parameters ​

draft ​

string

Returns ​

Promise<string>

say ​

say: (id, text, model?) => Promise<Creation>

Parameters ​

id ​

string

text ​

string

model? ​

string

Returns ​

Promise<Creation>

submit ​

submit: (form) => Promise<Creation>

Parameters ​

form ​

BriefForm

Returns ​

Promise<Creation>