Type aliases
Clause
Clause<C>: C | C[]
Type parameters
EntityConstructor
Entity
Constructor
: (new () => EntityInterface) & { class
: string; nymph
: Nymph; factory
: any; factoryReference
: any; factorySync
: any; serverCallStatic
: any }EntityJson
Entity
Json
<T>: { cdate
: number | null; class
: T["class"]; data
: EntityData; guid
: string | null; mdate
: number | null; tags
: string[] }Type parameters
Type declaration
cdate: number | null
class: T["class"]
guid: string | null
mdate: number | null
tags: string[]
EntityPatch
Entity
Patch
: { addTags
: string[]; class
: string; guid
: string; mdate
: number | null; removeTags
: string[]; set
: EntityData; unset
: string[] }Type declaration
addTags: string[]
class: string
guid: string
mdate: number | null
removeTags: string[]
unset: string[]
EntityReference
EntityReference: ["nymph_entity_reference", string, string]
EventType
EventType: "request" | "response"
HttpRequesterEventType
HttpRequesterEventType: "request" | "response"
HttpRequesterRequestCallback
HttpRequesterRequestCallback: (requester: HttpRequester, url: string, options: RequestInit) => void
Type declaration
- (requester: HttpRequester, url: string, options: RequestInit): void
Parameters
requester: HttpRequester
url: string
options: RequestInit
Returns void
HttpRequesterRequestOptions
HttpRequesterRequestOptions: { data: {}; dataType: string; url: string }
Type declaration
data: {}
dataType: string
url: string
HttpRequesterResponseCallback
HttpRequesterResponseCallback: (requester: HttpRequester, response: Response) => void
Type declaration
- (requester: HttpRequester, response: Response): void
Parameters
requester: HttpRequester
response: Response
Returns void
NymphOptions
NymphOptions: { WebSocket?: typeof WebSocket; fetch?: WindowOrWorkerGlobalScope["fetch"]; noConsole?: boolean; pubsubUrl?: string; restUrl: string; weakCache?: boolean }
Type declaration
Optional WebSocket?: typeof WebSocket
Optional fetch?: WindowOrWorkerGlobalScope["fetch"]
Optional noConsole?: boolean
Optional pubsubUrl?: string
restUrl: string
Optional weakCache?: boolean
Options
Options<T>: { class: T; limit?: number; offset?: number; return?: "entity" | "guid"; reverse?: boolean; skipCache?: boolean; sort?: "cdate" | "mdate" }
Type parameters
Type declaration
class: T
Optional limit?: number
Optional offset?: number
Optional return?: "entity" | "guid"
Optional reverse?: boolean
Optional skipCache?: boolean
Optional sort?: "cdate" | "mdate"
OrWithTime
OrWithTime<T>: T | [string, null, string]
Type parameters
PubSubCallbacks
Type parameters
PubSubConnectCallback
PubSubConnectCallback: () => void
PubSubCountCallback
PubSubCountCallback: (count: number) => void
PubSubDisconnectCallback
PubSubDisconnectCallback: () => void
PubSubEventType
PubSubEventType: "connect" | "disconnect"
PubSubRejectCallback
PubSubRejectCallback: (err: any) => void
PubSubResolveCallback
PubSubResolveCallback<T>: (arg: T, event?: string) => void
Type parameters
Type declaration
- (arg: T, event?: string): void
Parameters
arg: T
Optional event: string
Returns void
PubSubSubscribable
Type parameters
PubSubUpdate
Pub
Sub
Update
<T>: T | { query
: string; removed
: string } | { added
: string; data
: EntityJson; query
: string } | { data
: EntityJson; query
: string; updated
: string }Type parameters
RequestCallback
RequestCallback: (url: string, options: RequestInit) => void
Type declaration
- (url: string, options: RequestInit): void
Parameters
url: string
options: RequestInit
Returns void
ResponseCallback
ResponseCallback: (response: Response) => void
Type declaration
- (response: Response): void
Selector
Type declaration
Optional !contain?: Clause<OrWithTime<PrimitiveSelector["contain"]>>
Optional !defined?: Clause<PrimitiveSelector["defined"]>
Optional !equal?: Clause<OrWithTime<PrimitiveSelector["equal"]>>
Optional !gt?: Clause<OrWithTime<PrimitiveSelector["gt"]>>
Optional !gte?: Clause<OrWithTime<PrimitiveSelector["gte"]>>
Optional !guid?: Clause<PrimitiveSelector["guid"]>
Optional !ilike?: Clause<PrimitiveSelector["ilike"]>
Optional !imatch?: Clause<PrimitiveSelector["imatch"]>
Optional !like?: Clause<PrimitiveSelector["like"]>
Optional !lt?: Clause<OrWithTime<PrimitiveSelector["lt"]>>
Optional !lte?: Clause<OrWithTime<PrimitiveSelector["lte"]>>
Optional !match?: Clause<PrimitiveSelector["match"]>
Optional !qref?: Selector["qref"]
Optional !ref?: Clause<PrimitiveSelector["ref"]>
Optional !selector?: Selector["selector"]
Optional !tag?: Clause<PrimitiveSelector["tag"]>
Optional !truthy?: Clause<PrimitiveSelector["truthy"]>
Optional contain?: Clause<OrWithTime<PrimitiveSelector["contain"]>>
Optional defined?: Clause<PrimitiveSelector["defined"]>
Optional equal?: Clause<OrWithTime<PrimitiveSelector["equal"]>>
Optional gt?: Clause<OrWithTime<PrimitiveSelector["gt"]>>
Optional gte?: Clause<OrWithTime<PrimitiveSelector["gte"]>>
Optional guid?: Clause<PrimitiveSelector["guid"]>
Optional ilike?: Clause<PrimitiveSelector["ilike"]>
Optional imatch?: Clause<PrimitiveSelector["imatch"]>
Optional like?: Clause<PrimitiveSelector["like"]>
Optional lt?: Clause<OrWithTime<PrimitiveSelector["lt"]>>
Optional lte?: Clause<OrWithTime<PrimitiveSelector["lte"]>>
Optional match?: Clause<PrimitiveSelector["match"]>
Optional ref?: Clause<PrimitiveSelector["ref"]>
Optional tag?: Clause<PrimitiveSelector["tag"]>
Optional truthy?: Clause<PrimitiveSelector["truthy"]>
type: "&" | "|" | "!&" | "!|"
SerializedEntityData
SerializedEntityData: {}
ServerCallResponse
Server
Call
Response
: { entity
?: EntityJson; return
: any }ServerCallStaticResponse
ServerCallStaticResponse: any
A WebSocket implementation.