Class MethodSearchIndex

constructor

• new MethodSearchIndex(
      records: MethodRecord[],
      serialised?: string,
  ): MethodSearchIndex

  Parameters

  • records: MethodRecord[]

    method records

  • Optionalserialised: string

    previously serialised MiniSearch JSON

  Returns MethodSearchIndex

Readonlyrecords

browse

• browse(
      opts: {
          perClass: number;
          tag?: string;
          visible: (r: MethodRecord) => boolean;
      },
  ): {
      api: string;
      methodCount: number;
      methods: { id: string; summary?: string }[];
      more: number;
      tags: string[];
  }[]

  Overview of capabilities grouped by API class, for agents that do not yet know the API's vocabulary.

  Parameters

  • opts: { perClass: number; tag?: string; visible: (r: MethodRecord) => boolean }

    options

    • perClass: number

      method names listed per class

    • Optionaltag?: string

      restrict to a tag or API class (lists all)

    • visible: (r: MethodRecord) => boolean

      filter for records the caller may use

  Returns {
      api: string;
      methodCount: number;
      methods: { id: string; summary?: string }[];
      more: number;
      tags: string[];
  }[]

  groups

get

• get(id: string): MethodRecord | undefined

  Look up a record by id.

  Parameters

  • id: string

    "."

  Returns MethodRecord | undefined

  record

search

• search(
      query: string,
      opts: {
          limit: number;
          tag?: string;
          visible: (r: MethodRecord) => boolean;
      },
  ): { hits: SearchHit[]; total: number }

  Ranked search restricted to visible records.

  Parameters

  • query: string

    free text

  • opts: { limit: number; tag?: string; visible: (r: MethodRecord) => boolean }

    options

    • limit: number

      maximum results

    • Optionaltag?: string

      restrict to a tag or API class

    • visible: (r: MethodRecord) => boolean

      filter for records the caller may use

  Returns { hits: SearchHit[]; total: number }

  { hits, total }

serialise

• serialise(): string

  Serialise the full-text index.

  Returns string

  JSON