Class NymphDriverAbstract

ProtectedentityCache

ProtectedentityCount

Protectednymph

Protectedtokenizer

ProtectedcleanCache

• cleanCache(guid): void

• Remove all copies of an entity from the cache.

  Parameters

  • guid: string

    The GUID of the entity to remove.

  Returns void

ProtectedentityReferenceSearch

• entityReferenceSearch(value, entity): boolean

• Search through a value for an entity reference.

  Parameters

  • value: any

    Any value to search.
  • entity:
        | string
        | EntityInterface
        | EntityReference
        | (string | EntityInterface | EntityReference)[]

    An entity, GUID, or array of either to search for.

  Returns boolean

  True if the reference is found, false otherwise.

ProtectedfindReferences

• findReferences(svalue): string[]

• Parameters

  • svalue: string

  Returns string[]

ProtectedgetEntitiesRowLike

• getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
      process: (() => number | Error);
      result: any;
  }

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "count";
    }
  • selectors: Selector[]
  • performQueryCallback: ((data: {
        etype: string;
        options: Options<T>;
        selectors: FormattedSelector[];
    }) => {
        result: any;
    })
    • • (data): {
            result: any;
        }

      • Parameters

        • data: {
              etype: string;
              options: Options<T>;
              selectors: FormattedSelector[];
          }

          • etype: string

          • options: Options<T>

          • selectors: FormattedSelector[]

        Returns {
            result: any;
        }

        • result: any

  • rowFetchCallback: (() => any)
    • • (): any

      • Returns any

  • freeResultCallback: (() => void)
    • • (): void

      • Returns void

  • getCountCallback: ((row: any) => number)
    • • (row): number

      • Parameters

        • row: any

        Returns number

  • getGUIDCallback: ((row: any) => string)
    • • (row): string

      • Parameters

        • row: any

        Returns string

  • getTagsAndDatesCallback: ((row: any) => {
        cdate: number;
        mdate: number;
        tags: string[];
    })
    • • (row): {
            cdate: number;
            mdate: number;
            tags: string[];
        }

      • Parameters

        • row: any

        Returns {
            cdate: number;
            mdate: number;
            tags: string[];
        }

        • cdate: number

        • mdate: number

        • tags: string[]

  • getDataNameAndSValueCallback: ((row: any) => {
        name: string;
        svalue: string;
    })
    • • (row): {
            name: string;
            svalue: string;
        }

      • Parameters

        • row: any

        Returns {
            name: string;
            svalue: string;
        }

        • name: string

        • svalue: string

  Returns {
      process: (() => number | Error);
      result: any;
  }

  • process: (() => number | Error)

    • • (): number | Error

      • Returns number | Error

  • result: any

• getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
      process: (() => Error | string[]);
      result: any;
  }

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "guid";
    }
  • selectors: Selector[]
  • performQueryCallback: ((data: {
        etype: string;
        options: Options<T>;
        selectors: FormattedSelector[];
    }) => {
        result: any;
    })
    • • (data): {
            result: any;
        }

      • Parameters

        • data: {
              etype: string;
              options: Options<T>;
              selectors: FormattedSelector[];
          }

          • etype: string

          • options: Options<T>

          • selectors: FormattedSelector[]

        Returns {
            result: any;
        }

        • result: any

  • rowFetchCallback: (() => any)
    • • (): any

      • Returns any

  • freeResultCallback: (() => void)
    • • (): void

      • Returns void

  • getCountCallback: ((row: any) => number)
    • • (row): number

      • Parameters

        • row: any

        Returns number

  • getGUIDCallback: ((row: any) => string)
    • • (row): string

      • Parameters

        • row: any

        Returns string

  • getTagsAndDatesCallback: ((row: any) => {
        cdate: number;
        mdate: number;
        tags: string[];
    })
    • • (row): {
            cdate: number;
            mdate: number;
            tags: string[];
        }

      • Parameters

        • row: any

        Returns {
            cdate: number;
            mdate: number;
            tags: string[];
        }

        • cdate: number

        • mdate: number

        • tags: string[]

  • getDataNameAndSValueCallback: ((row: any) => {
        name: string;
        svalue: string;
    })
    • • (row): {
            name: string;
            svalue: string;
        }

      • Parameters

        • row: any

        Returns {
            name: string;
            svalue: string;
        }

        • name: string

        • svalue: string

  Returns {
      process: (() => Error | string[]);
      result: any;
  }

  • process: (() => Error | string[])

    • • (): Error | string[]

      • Returns Error | string[]

  • result: any

• getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
      process: (() => Error | EntityObjectType<T>[]);
      result: any;
  }

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T> & {
        return: "object";
    }
  • selectors: Selector[]
  • performQueryCallback: ((data: {
        etype: string;
        options: Options<T>;
        selectors: FormattedSelector[];
    }) => {
        result: any;
    })
    • • (data): {
            result: any;
        }

      • Parameters

        • data: {
              etype: string;
              options: Options<T>;
              selectors: FormattedSelector[];
          }

          • etype: string

          • options: Options<T>

          • selectors: FormattedSelector[]

        Returns {
            result: any;
        }

        • result: any

  • rowFetchCallback: (() => any)
    • • (): any

      • Returns any

  • freeResultCallback: (() => void)
    • • (): void

      • Returns void

  • getCountCallback: ((row: any) => number)
    • • (row): number

      • Parameters

        • row: any

        Returns number

  • getGUIDCallback: ((row: any) => string)
    • • (row): string

      • Parameters

        • row: any

        Returns string

  • getTagsAndDatesCallback: ((row: any) => {
        cdate: number;
        mdate: number;
        tags: string[];
    })
    • • (row): {
            cdate: number;
            mdate: number;
            tags: string[];
        }

      • Parameters

        • row: any

        Returns {
            cdate: number;
            mdate: number;
            tags: string[];
        }

        • cdate: number

        • mdate: number

        • tags: string[]

  • getDataNameAndSValueCallback: ((row: any) => {
        name: string;
        svalue: string;
    })
    • • (row): {
            name: string;
            svalue: string;
        }

      • Parameters

        • row: any

        Returns {
            name: string;
            svalue: string;
        }

        • name: string

        • svalue: string

  Returns {
      process: (() => Error | EntityObjectType<T>[]);
      result: any;
  }

  • process: (() => Error | EntityObjectType<T>[])

    • • (): Error | EntityObjectType<T>[]

      • Returns Error | EntityObjectType<T>[]

  • result: any

• getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
      process: (() => Error | EntityInstanceType<T>[]);
      result: any;
  }

• Type Parameters

  • T extends EntityConstructor = EntityConstructor

  Parameters

  • options: Options<T>
  • selectors: Selector[]
  • performQueryCallback: ((data: {
        etype: string;
        options: Options<T>;
        selectors: FormattedSelector[];
    }) => {
        result: any;
    })
    • • (data): {
            result: any;
        }

      • Parameters

        • data: {
              etype: string;
              options: Options<T>;
              selectors: FormattedSelector[];
          }

          • etype: string

          • options: Options<T>

          • selectors: FormattedSelector[]

        Returns {
            result: any;
        }

        • result: any

  • rowFetchCallback: (() => any)
    • • (): any

      • Returns any

  • freeResultCallback: (() => void)
    • • (): void

      • Returns void

  • getCountCallback: ((row: any) => number)
    • • (row): number

      • Parameters

        • row: any

        Returns number

  • getGUIDCallback: ((row: any) => string)
    • • (row): string

      • Parameters

        • row: any

        Returns string

  • getTagsAndDatesCallback: ((row: any) => {
        cdate: number;
        mdate: number;
        tags: string[];
    })
    • • (row): {
            cdate: number;
            mdate: number;
            tags: string[];
        }

      • Parameters

        • row: any

        Returns {
            cdate: number;
            mdate: number;
            tags: string[];
        }

        • cdate: number

        • mdate: number

        • tags: string[]

  • getDataNameAndSValueCallback: ((row: any) => {
        name: string;
        svalue: string;
    })
    • • (row): {
            name: string;
            svalue: string;
        }

      • Parameters

        • row: any

        Returns {
            name: string;
            svalue: string;
        }

        • name: string

        • svalue: string

  Returns {
      process: (() => Error | EntityInstanceType<T>[]);
      result: any;
  }

  • process: (() => Error | EntityInstanceType<T>[])

    • • (): Error | EntityInstanceType<T>[]

      • Returns Error | EntityInstanceType<T>[]

  • result: any

Protected AbstractinternalTransaction

• internalTransaction(name): Promise<any>

• Parameters

  • name: string

  Returns Promise<any>

ProtectediterateSelectorsForQuery

• iterateSelectorsForQuery(selectors, callback): string[]

• Parameters

  • selectors: FormattedSelector[]
  • callback: ((data: {
        key: string;
        typeIsNot: boolean;
        typeIsOr: boolean;
        value: any;
    }) => string)
    • • (data): string

      • Parameters

        • data: {
              key: string;
              typeIsNot: boolean;
              typeIsOr: boolean;
              value: any;
          }

          • key: string

          • typeIsNot: boolean

          • typeIsOr: boolean

          • value: any

        Returns string

  Returns string[]

ProtectedposixRegexMatch

• posixRegexMatch(pattern, subject, caseInsensitive?): boolean

• Parameters

  • pattern: string
  • subject: string
  • caseInsensitive: boolean = false

  Returns boolean

ProtectedpullCache

• pullCache(guid): null | {
      cdate: number;
      data: EntityData;
      guid: string;
      mdate: number;
      sdata: SerializedEntityData;
      tags: string[];
  }

• Pull an entity from the cache.

  Parameters

  • guid: string

    The entity's GUID.

  Returns null | {
      cdate: number;
      data: EntityData;
      guid: string;
      mdate: number;
      sdata: SerializedEntityData;
      tags: string[];
  }

  The entity's data or null if it's not cached.

ProtectedpushCache

• pushCache(guid, cdate, mdate, tags, data, sdata): void

• Push an entity onto the cache.

  Parameters

  • guid: string

    The entity's GUID.
  • cdate: number

    The entity's cdate.
  • mdate: number

    The entity's mdate.
  • tags: string[]

    The entity's tags.
  • data: EntityData

    The entity's data.
  • sdata: SerializedEntityData

    The entity's sdata.

  Returns void

ProtectedsaveEntityRowLike

• saveEntityRowLike(entity, saveNewEntityCallback, saveExistingEntityCallback, startTransactionCallback?, commitTransactionCallback?): Promise<boolean>

• Parameters

  • entity: EntityInterface
  • saveNewEntityCallback: ((data: {
        cdate: number;
        data: EntityData;
        entity: EntityInterface;
        etype: string;
        guid: string;
        sdata: SerializedEntityData;
        tags: string[];
        uniques: string[];
    }) => Promise<boolean>)
    • • (data): Promise<boolean>

      • Parameters

        • data: {
              cdate: number;
              data: EntityData;
              entity: EntityInterface;
              etype: string;
              guid: string;
              sdata: SerializedEntityData;
              tags: string[];
              uniques: string[];
          }

          • cdate: number

          • data: EntityData

          • entity: EntityInterface

          • etype: string

          • guid: string

          • sdata: SerializedEntityData

          • tags: string[]

          • uniques: string[]

        Returns Promise<boolean>

  • saveExistingEntityCallback: ((data: {
        data: EntityData;
        entity: EntityInterface;
        etype: string;
        guid: string;
        mdate: number;
        sdata: SerializedEntityData;
        tags: string[];
        uniques: string[];
    }) => Promise<boolean>)
    • • (data): Promise<boolean>

      • Parameters

        • data: {
              data: EntityData;
              entity: EntityInterface;
              etype: string;
              guid: string;
              mdate: number;
              sdata: SerializedEntityData;
              tags: string[];
              uniques: string[];
          }

          • data: EntityData

          • entity: EntityInterface

          • etype: string

          • guid: string

          • mdate: number

          • sdata: SerializedEntityData

          • tags: string[]

          • uniques: string[]

        Returns Promise<boolean>

  • startTransactionCallback: null | (() => Promise<void>) = null
  • commitTransactionCallback: null | ((success: boolean) => Promise<boolean>) = null

  Returns Promise<boolean>