Class Namespace

constructor

• new Namespace(options: NamespaceOptions): Namespace

  Creates a new namespace.

  Parameters

  • options: NamespaceOptions

  Returns Namespace

id

queries

queryGetters

shorthand

addQuery

• addQuery(query: Query): Namespace

  Adds a new query to the namespace.

  Parameters

  • query: Query

  Returns Namespace

addQueryGetter

• addQueryGetter(id: string, getter: (incomplete: string) => Query[]): Namespace

  Adds a getter function that returns dynamically generated queries.

  Parameters

  • id: string
  • getter: (incomplete: string) => Query[]

  Returns Namespace

createUnion

• createUnion(other: Namespace, options?: NamespaceUnionOptions): Namespace

  Creates a new namespace that is a union of this namespace and another.

  Parameters

  • other: Namespace
  • Optionaloptions: NamespaceUnionOptions

  Returns Namespace

getPossibleQueries

• getPossibleQueries(
      expression: string,
      incomplete: string,
      recursive?: boolean,
  ): Query[]

  Returns any queries in this namespace who's ID starts with incomplete.

  Parameters

  • expression: string
  • incomplete: string
  • Optionalrecursive: boolean

  Returns Query[]

hasQuery

• hasQuery(queryID: string): boolean

  Checks if the namespace has a query.

  Parameters

  • queryID: string

  Returns boolean

removeQuery

• removeQuery(queryID: string): boolean

  Removes a query from the namespace.

  Parameters

  • queryID: string

  Returns boolean

removeQueryGetter

• removeQueryGetter(id: string): void

  Removes a query getter function.

  Parameters

  • id: string

  Returns void