Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

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

  • C

EntityConstructor

EntityConstructor: (new (guid?: string) => EntityInterface) & { ETYPE: string; class: string; clientEnabledStaticMethods: string[]; nymph: Nymph; searchRestrictedData: string[]; alterOptions?: any; factory: any; factoryReference: any; factorySync: any }

EntityData

EntityData: {}

Type declaration

  • [k: string]: any

EntityJson

EntityJson: { cdate: number | null; class: string; data: EntityData; guid: string | null; mdate: number | null; tags: string[] }

Type declaration

  • cdate: number | null
  • class: string
  • data: EntityData
  • guid: string | null
  • mdate: number | null
  • tags: string[]

EntityPatch

EntityPatch: { 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[]
  • set: EntityData
  • unset: string[]

EntityReference

EntityReference: ["nymph_entity_reference", string, string]

FormattedSelector

FormattedSelector: { !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 !qref?: FormattedSelector["qref"]
  • Optional !ref?: PrimitiveSelector["ref"][]
  • Optional !selector?: FormattedSelector["selector"]
  • 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 qref?: [string, [Options, ...FormattedSelector[]]][]
  • Optional ref?: PrimitiveSelector["ref"][]
  • Optional selector?: FormattedSelector[]
  • Optional tag?: PrimitiveSelector["tag"][][]
  • Optional truthy?: PrimitiveSelector["truthy"][][]
  • type: "&" | "|" | "!&" | "!|"

NymphAfterDeleteEntityByIDCallback

NymphAfterDeleteEntityByIDCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphAfterDeleteEntityCallback

NymphAfterDeleteEntityCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphAfterDeleteUIDCallback

NymphAfterDeleteUIDCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphAfterNewUIDCallback

NymphAfterNewUIDCallback: (nymph: Nymph, result: Promise<number | null>) => void

Type declaration

    • (nymph: Nymph, result: Promise<number | null>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<number | null>

      Returns void

NymphAfterRenameUIDCallback

NymphAfterRenameUIDCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphAfterSaveEntityCallback

NymphAfterSaveEntityCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphAfterSetUIDCallback

NymphAfterSetUIDCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphBeforeDeleteEntityByIDCallback

NymphBeforeDeleteEntityByIDCallback: (nymph: Nymph, guid: string, className?: string) => void

Type declaration

    • (nymph: Nymph, guid: string, className?: string): void
    • Parameters

      • nymph: Nymph
      • guid: string
      • Optional className: string

      Returns void

NymphBeforeDeleteEntityCallback

NymphBeforeDeleteEntityCallback: (nymph: Nymph, entity: EntityInterface) => void

Type declaration

NymphBeforeDeleteUIDCallback

NymphBeforeDeleteUIDCallback: (nymph: Nymph, name: string) => void

Type declaration

    • (nymph: Nymph, name: string): void
    • Parameters

      Returns void

NymphBeforeGetEntitiesCallback

NymphBeforeGetEntitiesCallback: (nymph: Nymph, options: Options, selectors: Selector[]) => void

Type declaration

NymphBeforeGetEntityCallback

NymphBeforeGetEntityCallback: (nymph: Nymph, options: Options, selectors: Selector[]) => void

Type declaration

NymphBeforeNewUIDCallback

NymphBeforeNewUIDCallback: (nymph: Nymph, name: string) => void

Type declaration

    • (nymph: Nymph, name: string): void
    • Parameters

      Returns void

NymphBeforeRenameUIDCallback

NymphBeforeRenameUIDCallback: (nymph: Nymph, oldName: string, newName: string) => void

Type declaration

    • (nymph: Nymph, oldName: string, newName: string): void
    • Parameters

      • nymph: Nymph
      • oldName: string
      • newName: string

      Returns void

NymphBeforeSaveEntityCallback

NymphBeforeSaveEntityCallback: (nymph: Nymph, entity: EntityInterface) => void

Type declaration

NymphBeforeSetUIDCallback

NymphBeforeSetUIDCallback: (nymph: Nymph, name: string, value: number) => void

Type declaration

    • (nymph: Nymph, name: string, value: number): void
    • Parameters

      • nymph: Nymph
      • name: string
      • value: number

      Returns void

NymphConnectCallback

NymphConnectCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphDisconnectCallback

NymphDisconnectCallback: (nymph: Nymph, result: Promise<boolean>) => void

Type declaration

    • (nymph: Nymph, result: Promise<boolean>): void
    • Parameters

      • nymph: Nymph
      • result: Promise<boolean>

      Returns void

NymphEventType

NymphEventType: "connect" | "disconnect" | "query" | "beforeGetEntity" | "beforeGetEntities" | "beforeSaveEntity" | "afterSaveEntity" | "beforeDeleteEntity" | "afterDeleteEntity" | "beforeDeleteEntityByID" | "afterDeleteEntityByID" | "beforeNewUID" | "afterNewUID" | "beforeSetUID" | "afterSetUID" | "beforeRenameUID" | "afterRenameUID" | "beforeDeleteUID" | "afterDeleteUID"

NymphQueryCallback

NymphQueryCallback: (nymph: Nymph, options: Options, selectors: FormattedSelector[]) => void

Type declaration

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

  • T

Selector

Selector: { !contain?: Clause<OrWithTime<PrimitiveSelector["contain"]>>; !defined?: Clause<PrimitiveSelector["defined"]>; !equal?: Clause<OrWithTime<PrimitiveSelector["equal"]>>; !gt?: Clause<OrWithTime<PrimitiveSelector["gt"]>>; !gte?: Clause<OrWithTime<PrimitiveSelector["gte"]>>; !guid?: Clause<PrimitiveSelector["guid"]>; !ilike?: Clause<PrimitiveSelector["ilike"]>; !imatch?: Clause<PrimitiveSelector["imatch"]>; !like?: Clause<PrimitiveSelector["like"]>; !lt?: Clause<OrWithTime<PrimitiveSelector["lt"]>>; !lte?: Clause<OrWithTime<PrimitiveSelector["lte"]>>; !match?: Clause<PrimitiveSelector["match"]>; !qref?: Selector["qref"]; !ref?: Clause<PrimitiveSelector["ref"]>; !selector?: Selector["selector"]; !tag?: Clause<PrimitiveSelector["tag"]>; !truthy?: Clause<PrimitiveSelector["truthy"]>; contain?: Clause<OrWithTime<PrimitiveSelector["contain"]>>; defined?: Clause<PrimitiveSelector["defined"]>; equal?: Clause<OrWithTime<PrimitiveSelector["equal"]>>; gt?: Clause<OrWithTime<PrimitiveSelector["gt"]>>; gte?: Clause<OrWithTime<PrimitiveSelector["gte"]>>; guid?: Clause<PrimitiveSelector["guid"]>; ilike?: Clause<PrimitiveSelector["ilike"]>; imatch?: Clause<PrimitiveSelector["imatch"]>; like?: Clause<PrimitiveSelector["like"]>; lt?: Clause<OrWithTime<PrimitiveSelector["lt"]>>; lte?: Clause<OrWithTime<PrimitiveSelector["lte"]>>; match?: Clause<PrimitiveSelector["match"]>; qref?: Clause<[string, [Options, ...Selector[]]]>; ref?: Clause<PrimitiveSelector["ref"]>; selector?: Clause<Selector>; tag?: Clause<PrimitiveSelector["tag"]>; truthy?: Clause<PrimitiveSelector["truthy"]>; type: "&" | "|" | "!&" | "!|" }

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 qref?: Clause<[string, [Options, ...Selector[]]]>
  • Optional ref?: Clause<PrimitiveSelector["ref"]>
  • Optional selector?: Clause<Selector>
  • Optional tag?: Clause<PrimitiveSelector["tag"]>
  • Optional truthy?: Clause<PrimitiveSelector["truthy"]>
  • type: "&" | "|" | "!&" | "!|"

SerializedEntityData

SerializedEntityData: {}

Type declaration

  • [k: string]: string

Properties

ConfigDefaults

ConfigDefaults: Config

nymphJoiProps

nymphJoiProps: { cdate: AlternativesSchema; guid: AlternativesSchema; mdate: AlternativesSchema; tags: ArraySchema }

Type declaration

  • cdate: AlternativesSchema
  • guid: AlternativesSchema
  • mdate: AlternativesSchema
  • tags: ArraySchema

Functions

ExportImportTest

  • ExportImportTest(nymph: Nymph, it: (name: string, fn: () => void) => void): void

QueriesTest

  • QueriesTest(nymph: Nymph, it: (name: string, fn: () => void) => void): void

UIDTest

  • UIDTest(nymph: Nymph, it: (name: string, fn: () => void) => void): void

entitiesToReferences

  • entitiesToReferences(item: any): any

newGUID

  • newGUID(): string

referencesToEntities

  • referencesToEntities(item: any, nymph: Nymph, useSkipAc?: boolean): any

sortObj

  • sortObj<T>(obj: T): T

uniqueStrings

  • uniqueStrings(array: string[]): string[]

xor

  • xor(a: any, b: any): boolean

Generated using TypeDoc