get_geo_json

​

get_geo_json

• get_geo_json(
  table_name: string,
  offset?: number,
  limit?: number,
  options?: Record<string, string>,
  callback?: GPUdbCallback,
  ): Promise<Record<string, any>>

  Retrieves records from a table as a GeoJSON FeatureCollection.

  A convenience wrapper over /get/records with encoding forced to geojson, unwrapping the single encoded document the server returns.

  ​

  Parameters

  • table_name: string

    Table to read from

  • Optionaloffset: number

    Record offset; defaults to 0

  • Optionallimit: number

    Maximum records to return; defaults to 10000

  • Optionaloptions: Record<string, string>

    Optional parameters for /get/records

  • Optionalcallback: GPUdbCallback

    Optional callback function

  ​

  Returns Promise<Record<string, any>>

  Promise resolving to the GeoJSON FeatureCollection

  ​

  Example

  const geo = await gpudb.get_geo_json('shapes', 0, 100, {});
  geo.type;        // 'FeatureCollection'
  geo.features;    // [...]
  

  • Defined in src/GPUdb.ts:15877