Options
All
  • Public
  • Public/Protected
  • All
Menu

Data interface map oprions.

Type Parameters

  • Original

    The original item type in the data.

  • Mapped

    The type after mapping.

Hierarchy

  • DataInterfaceMapOptions

Index

Properties

Methods

Properties

fields?: Record<string, string> | string[]

An array with field names, or an object with current field name and new field name that the field is returned as. By default, all properties of the items are emitted. When fields is defined, only the properties whose name is specified in fields will be included in the returned items.

order?: DataInterfaceOrder<Mapped>

Order the items by a field name or custom sort function.

Methods

  • filter(item: Original): boolean
  • Items can be filtered on specific properties by providing a filter function. A filter function is executed for each of the items in the DataSet, and is called with the item as parameter. The function must return a boolean. All items for which the filter function returns true will be emitted.

    Parameters

    • item: Original

    Returns boolean

Generated using TypeDoc