Function polygon

polygon(apiKey: string, polygon: Polygon | FeatureCollection<Geometry, GeoJsonProperties> | Feature<Geometry, GeoJsonProperties>, options?: {
limit?: number;
offset?: number;
}): Promise<OSFeatureCollection>
Get places within a polygon extent.

Returns
- A GeoJSON Feature Collection
Parameters
- apiKey: string
  
  A valid OS Data Hub key
- polygon: Polygon | FeatureCollection<Geometry, GeoJsonProperties> | Feature<Geometry, GeoJsonProperties>
  
  A GeoJSON polygon
- 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>
- Defined in places.ts:98