api - activitystream/asa.js GitHub Wiki

@activitystream/asa > api

Module: api

Classes

Type aliases

Functions


Type aliases

AsaError

ΤAsaError: object

Defined in api.ts:37

Type declaration

code: number


ErrorDispatcher

ΤErrorDispatcher: function

Defined in api.ts:52

Type declaration

▸(error: AsaError, context?: object): Promise<Response>

Parameters:

Param Type
error AsaError
Optional context object

Returns: Promise<Response>


ErrorRequest

ΤErrorRequest: object

Defined in api.ts:40

Type declaration

Optional context: object

err: AsaError

v: string


EventDispatcher

ΤEventDispatcher: function

Defined in api.ts:51

Type declaration

▸(event: Event): Promise<Response>

Parameters:

Param Type
event Event

Returns: Promise<Response>


EventRequest

ΤEventRequest: object

Defined in api.ts:39

Type declaration

ev: object

t: string


Functions

<Const> ERROR

ERROR(data: object): Promise<Response>

Defined in api.ts:48

Parameters:

Param Type
data object

Returns: Promise<Response>


<Const> EVENT

EVENT(data: EventRequest): Promise<Response>

Defined in api.ts:46

Parameters:

Param Type
data EventRequest

Returns: Promise<Response>


<Const> POST

POST(url: string, data: object): Promise<Response>

Defined in api.ts:28

Parameters:

Param Type
url string
data object

Returns: Promise<Response>


<Const> submitError

submitError(err: object, context?: object): Promise<Response>

Defined in api.ts:63

Parameters:

Param Type
err object
Optional context object

Returns: Promise<Response>


<Const> submitEvent

submitEvent(ev: Event): Promise<Response>

Defined in api.ts:57

Parameters:

Param Type
ev Event

Returns: Promise<Response>


<Const> toDigits

toDigits(d: number, n: number): string

Defined in api.ts:9

Parameters:

Param Type
d number
n number

Returns: string


⚠️ **GitHub.com Fallback** ⚠️