Type aliases
ACProperties
ACProperties: { acFull: any; acGroup: any; acOther: any; acRead: any; acUser: any; acWrite: any; group: any; user: any }
Type declaration
acFull: any
acGroup: any
acOther: any
acRead: any
acUser: any
acWrite: any
group: any
user: any
Clause
Clause<C>: C | C[]
Type parameters
EntityConstructor
Entity
Constructor
: (new (guid
?: string) => EntityInterface) & { ETYPE
: string; class
: string; clientEnabledStaticMethods
: string[]; nymph
: Nymph; searchRestrictedData
: string[]; alterOptions
?: any; factory
: any; factoryReference
: any; factorySync
: any }EntityJson
Entity
Json
: { cdate
: number | null; class
: string; data
: EntityData; guid
: string | null; mdate
: number | null; tags
: string[] }Type declaration
cdate: number | null
class: string
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]
FormattedSelector
Formatted
Selector
: { !contain
?: PrimitiveSelector["contain"][]; !defined
?: PrimitiveSelector["defined"][][]; !equal
?: PrimitiveSelector["equal"][]; !gt
?: PrimitiveSelector["gt"][]; !gte
?: PrimitiveSelector["gte"][]; !guid
?: PrimitiveSelector["guid"][][]; !ilike
?: PrimitiveSelector["ilike"][]; !imatch
?: PrimitiveSelector["imatch"][]; !like
?: PrimitiveSelector["like"][]; !lt
?: PrimitiveSelector["lt"][]; !lte
?: PrimitiveSelector["lte"][]; !match
?: PrimitiveSelector["match"][]; !qref
?: FormattedSelector["qref"]; !ref
?: PrimitiveSelector["ref"][]; !selector
?: FormattedSelector["selector"]; !tag
?: PrimitiveSelector["tag"][][]; !truthy
?: PrimitiveSelector["truthy"][][]; contain
?: PrimitiveSelector["contain"][]; defined
?: PrimitiveSelector["defined"][][]; equal
?: PrimitiveSelector["equal"][]; gt
?: PrimitiveSelector["gt"][]; gte
?: PrimitiveSelector["gte"][]; guid
?: PrimitiveSelector["guid"][][]; ilike
?: PrimitiveSelector["ilike"][]; imatch
?: PrimitiveSelector["imatch"][]; like
?: PrimitiveSelector["like"][]; lt
?: PrimitiveSelector["lt"][]; lte
?: PrimitiveSelector["lte"][]; match
?: PrimitiveSelector["match"][]; qref
?: [string, [Options, ...FormattedSelector[]]][]; ref
?: PrimitiveSelector["ref"][]; selector
?: FormattedSelector[]; tag
?: PrimitiveSelector["tag"][][]; truthy
?: PrimitiveSelector["truthy"][][]; type
: "&" | "|" | "!&" | "!|" }Type declaration
Optional !contain?: PrimitiveSelector["contain"][]
Optional !defined?: PrimitiveSelector["defined"][][]
Optional !equal?: PrimitiveSelector["equal"][]
Optional !gt?: PrimitiveSelector["gt"][]
Optional !gte?: PrimitiveSelector["gte"][]
Optional !guid?: PrimitiveSelector["guid"][][]
Optional !ilike?: PrimitiveSelector["ilike"][]
Optional !imatch?: PrimitiveSelector["imatch"][]
Optional !like?: PrimitiveSelector["like"][]
Optional !lt?: PrimitiveSelector["lt"][]
Optional !lte?: PrimitiveSelector["lte"][]
Optional !match?: PrimitiveSelector["match"][]
Optional !ref?: PrimitiveSelector["ref"][]
Optional !tag?: PrimitiveSelector["tag"][][]
Optional !truthy?: PrimitiveSelector["truthy"][][]
Optional contain?: PrimitiveSelector["contain"][]
Optional defined?: PrimitiveSelector["defined"][][]
Optional equal?: PrimitiveSelector["equal"][]
Optional gt?: PrimitiveSelector["gt"][]
Optional gte?: PrimitiveSelector["gte"][]
Optional guid?: PrimitiveSelector["guid"][][]
Optional ilike?: PrimitiveSelector["ilike"][]
Optional imatch?: PrimitiveSelector["imatch"][]
Optional like?: PrimitiveSelector["like"][]
Optional lt?: PrimitiveSelector["lt"][]
Optional lte?: PrimitiveSelector["lte"][]
Optional match?: PrimitiveSelector["match"][]
Optional ref?: PrimitiveSelector["ref"][]
Optional tag?: PrimitiveSelector["tag"][][]
Optional truthy?: PrimitiveSelector["truthy"][][]
type: "&" | "|" | "!&" | "!|"
NymphAfterDeleteEntityByIDCallback
Nymph
After
Delete
Entity
ByIDCallback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphAfterDeleteEntityCallback
Nymph
After
Delete
Entity
Callback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphAfterDeleteUIDCallback
Nymph
After
DeleteUIDCallback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphAfterNewUIDCallback
Nymph
After
NewUIDCallback
: (nymph
: Nymph, result
: Promise<number | null>) => voidType declaration
- (nymph: Nymph, result: Promise<number | null>): void
Parameters
result: Promise<number | null>
Returns void
NymphAfterRenameUIDCallback
Nymph
After
RenameUIDCallback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphAfterSaveEntityCallback
Nymph
After
Save
Entity
Callback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphAfterSetUIDCallback
Nymph
After
SetUIDCallback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphBeforeDeleteEntityByIDCallback
Nymph
Before
Delete
Entity
ByIDCallback
: (nymph
: Nymph, guid
: string, className
?: string) => voidType declaration
- (nymph: Nymph, guid: string, className?: string): void
Parameters
guid: string
Optional className: string
Returns void
NymphBeforeDeleteEntityCallback
NymphBeforeDeleteUIDCallback
Nymph
Before
DeleteUIDCallback
: (nymph
: Nymph, name
: string) => voidType declaration
- (nymph: Nymph, name: string): void
NymphBeforeGetEntitiesCallback
NymphBeforeGetEntityCallback
NymphBeforeNewUIDCallback
Nymph
Before
NewUIDCallback
: (nymph
: Nymph, name
: string) => voidType declaration
- (nymph: Nymph, name: string): void
NymphBeforeRenameUIDCallback
Nymph
Before
RenameUIDCallback
: (nymph
: Nymph, oldName
: string, newName
: string) => voidType declaration
- (nymph: Nymph, oldName: string, newName: string): void
Parameters
oldName: string
newName: string
Returns void
NymphBeforeSaveEntityCallback
NymphBeforeSetUIDCallback
Nymph
Before
SetUIDCallback
: (nymph
: Nymph, name
: string, value
: number) => voidType declaration
- (nymph: Nymph, name: string, value: number): void
Parameters
name: string
value: number
Returns void
NymphConnectCallback
Nymph
Connect
Callback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphDisconnectCallback
Nymph
Disconnect
Callback
: (nymph
: Nymph, result
: Promise<boolean>) => voidType declaration
- (nymph: Nymph, result: Promise<boolean>): void
NymphEventType
NymphEventType: "connect" | "disconnect" | "query" | "beforeGetEntity" | "beforeGetEntities" | "beforeSaveEntity" | "afterSaveEntity" | "beforeDeleteEntity" | "afterDeleteEntity" | "beforeDeleteEntityByID" | "afterDeleteEntityByID" | "beforeNewUID" | "afterNewUID" | "beforeSetUID" | "afterSetUID" | "beforeRenameUID" | "afterRenameUID" | "beforeDeleteUID" | "afterDeleteUID"
Options
Options<T>: { class?: T; limit?: number; offset?: number; return?: "entity" | "guid"; reverse?: boolean; skipAc?: boolean; skipCache?: boolean; sort?: "cdate" | "mdate"; source?: string }
Type parameters
Type declaration
Optional class?: T
Optional limit?: number
Optional offset?: number
Optional return?: "entity" | "guid"
Optional reverse?: boolean
Optional skipAc?: boolean
Optional skipCache?: boolean
Optional sort?: "cdate" | "mdate"
Optional source?: string
OrWithTime
OrWithTime<T>: T | [string, null, string]
Type parameters
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: {}
The NymphQueryCallback will be called on both top level and qref queries.