IRequestParameters

Symbol directory request parameters.

Properties

  • fieldId: SearchFieldIds

    Field to search on.
  • search: string

    The string.
  • matchType?: MatchType

    Whether to allow partial matches on `FID_NAME` searches. Note `FID_NAME` with `MatchType.exact` searches only apply to the first word of the name. If undefined, defaults to `MatchType.exact`.
  • filterType?: FilterType

    Filtering of results. Default is no filtering.
  • entityTypes?: EntityType | EntityType[]

    The set of entity types to include or exclude. Applies to `FilterType.includeEntityTypes` and `FilterType.excludeEntityTypes` only.

Also in this Section

Functions

Interfaces