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

Function: createApi()

createApi(platform): object

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

The creation calls, as the page's session.

Parameters

platform

Platform

Returns

cancel

cancel: (id) => Promise<Creation>

Parameters

id

string

Returns

Promise<Creation>

cities

cities: (query, offset, limit) => Promise<CityPage>

A page of the curated cities the words find.

Parameters

query

string

offset

number

limit?

number = CITY_PAGE

Returns

Promise<CityPage>

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>

remove

remove: (id, draft) => Promise<{ cancelled: boolean; draftDeleted: boolean; }>

Deletes a creation from the list (cancelled first when under way), its draft too when asked.

Parameters

id

string

draft?

boolean = false

Returns

Promise<{ cancelled: boolean; draftDeleted: boolean; }>

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>