Class Bindings

constructor

• new Bindings(
      dataFactory: ComunicaDataFactory,
      entries: Map<string, Term>,
      contextHolder?: IContextHolder,
  ): Bindings

  Parameters

  • dataFactory: ComunicaDataFactory
  • entries: Map<string, Term>
  • OptionalcontextHolder: IContextHolder

  Returns Bindings

Readonlytype

size

• get size(): number

  The number of variable-value pairs.

  Returns number

[iterator]

• "[iterator]"(): Iterator<[Variable, Term]>

  Returns Iterator<[Variable, Term]>

delete

• delete(key: string | Variable): Bindings

  Create a new Bindings object by removing the given variable.

  If the variable does not exist in the binding, a copy of the Bindings object is returned.

  Parameters

  • key: string | Variable

    The variable key term or string. If it is a string, no ? prefix must be given.

  Returns Bindings

deleteContextEntry

• deleteContextEntry<V>(key: IActionContextKey<V>): Bindings

  Type Parameters

  • V

  Parameters

  • key: IActionContextKey<V>

  Returns Bindings

deleteContextEntryRaw

• deleteContextEntryRaw<V>(key: IActionContextKey<V>): Bindings

  Type Parameters

  • V

  Parameters

  • key: IActionContextKey<V>

  Returns Bindings

equals

• equals(other: undefined | null | Bindings): boolean

  Check if all entries contained in this Bindings object are equal to all entries in the other Bindings object.

  Parameters

  • other: undefined | null | Bindings

    A Bindings object.

  Returns boolean

filter

• filter(fn: (value: Term, key: Variable) => boolean): Bindings

  Create a new Bindings object by filtering entries using a callback.

  Parameters

  • fn: (value: Term, key: Variable) => boolean

    A callback that is applied on each entry. Returning true indicates that this entry must be contained in the resulting Bindings object.

  Returns Bindings

forEach

• forEach(fn: (value: Term, key: Variable) => any): void

  Iterate over all variable-value pairs.

  Parameters

  • fn: (value: Term, key: Variable) => any

    A callback that is called for each variable-value pair with value as first argument, and variable as second argument.

  Returns void

get

• get(key: string | Variable): undefined | Term

  Obtain the binding value for the given variable.

  Parameters

  • key: string | Variable

    A variable term or string. If it is a string, no ? prefix must be given.

  Returns undefined | Term

getContext

• getContext(): undefined | IActionContext

  Returns undefined | IActionContext

getContextEntry

• getContextEntry<V>(key: IActionContextKey<V>): undefined | V

  Type Parameters

  • V

  Parameters

  • key: IActionContextKey<V>

  Returns undefined | V

has

• has(key: string | Variable): boolean

  Check if a binding exist for the given variable.

  Parameters

  • key: string | Variable

    A variable term or string. If it is a string, no ? prefix must be given.

  Returns boolean

keys

• keys(): Iterable<Variable>

  Obtain all variables for which mappings exist.

  Returns Iterable<Variable>

map

• map(fn: (value: Term, key: Variable) => Term): Bindings

  Create a new Bindings object by mapping entries using a callback.

  Parameters

  • fn: (value: Term, key: Variable) => Term

    A callback that is applied on each entry, in which the original value is replaced by the returned value.

  Returns Bindings

merge

• merge(other: Bindings | Bindings): undefined | Bindings

  Merge this bindings with another.

  If a merge conflict occurs (this and other have an equal variable with unequal value), then undefined is returned.

  Parameters

  • other: Bindings | Bindings

    A Bindings object.

  Returns undefined | Bindings

mergeWith

• mergeWith(
      merger: (self: Term, other: Term, key: Variable) => Term,
      other: Bindings | Bindings,
  ): Bindings

  Merge this bindings with another, where merge conflicts can be resolved using a callback function.

  Parameters

  • merger: (self: Term, other: Term, key: Variable) => Term

    A function that is invoked when a merge conflict occurs, for which the returned value is considered the merged value.
  • other: Bindings | Bindings

    A Bindings object.

  Returns Bindings

set

• set(key: string | Variable, value: Term): Bindings

  Create a new Bindings object by adding the given variable and value mapping.

  If the variable already exists in the binding, then the existing mapping is overwritten.

  Parameters

  • key: string | Variable

    The variable key term or string. If it is a string, no ? prefix must be given.
  • value: Term

    The value.

  Returns Bindings

setContextEntry

• setContextEntry<V>(key: IActionContextKey<V>, value: any): Bindings

  Type Parameters

  • V

  Parameters

  • key: IActionContextKey<V>
  • value: any

  Returns Bindings

setContextEntryRaw

• setContextEntryRaw<V>(key: IActionContextKey<V>, value: any): Bindings

  Type Parameters

  • V

  Parameters

  • key: IActionContextKey<V>
  • value: any

  Returns Bindings

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

values

• values(): Iterable<Term>

  Obtain all values that are mapped to.

  Returns Iterable<Term>