Function find

  • Find names that match a free text search.

    Returns

    • A GeoJSON Feature Collection

    Parameters

    • apiKey: string

      A valid OS Data Hub key

    • query: string

      Free text search parameter

    • options: {
          limit?: number;
          offset?: number;
      } = {}

      Optional arguments

      • Optional limit?: number

        The max number of features to return

      • Optional offset?: number

        The starting value for the offset

    Returns Promise<OSFeatureCollection>

Settings

Member Visibility

Theme

Generated using TypeDoc