minca
ApiSchemasNamespacesfragmentsFunctions

Function: placeFields()

function placeFields(): object;

Defined in: packages/core/src/schemas/fragments.ts:149

The fields of a place, for a definition that is one. cells are the geohashes of lat and lon at a few sizes (cellsOf in geo.ts), for a topic: a keeper matches them to find places in an area without reading.

Returns

object

address

address: object;

address.properties

properties: object;

address.properties.country

country: object;

address.properties.country.maxLength

maxLength: number = max;

address.properties.country.minLength?

minLength?: number = min;

address.properties.country.type

type: "string";

address.properties.locality

locality: object;

address.properties.locality.maxLength

maxLength: number = max;

address.properties.locality.minLength?

minLength?: number = min;

address.properties.locality.type

type: "string";

address.properties.postcode

postcode: object;

address.properties.postcode.maxLength

maxLength: number = max;

address.properties.postcode.minLength?

minLength?: number = min;

address.properties.postcode.type

type: "string";

address.properties.region

region: object;

address.properties.region.maxLength

maxLength: number = max;

address.properties.region.minLength?

minLength?: number = min;

address.properties.region.type

type: "string";

address.properties.street

street: object;

address.properties.street.maxLength

maxLength: number = max;

address.properties.street.minLength?

minLength?: number = min;

address.properties.street.type

type: "string";

address.type

type: "object";

cells

cells: object;

cells.description

description: string = 'The geohash cells lat and lon are in, coarsest first: precisions 3, 4, 5 and 6';

cells.items

items: object;

cells.items.maxLength

maxLength: number = max;

cells.items.minLength?

minLength?: number = min;

cells.items.type

type: "string";

cells.maxItems

maxItems: number = 8;

cells.type

type: "array";

lat

lat: object;

lat.maximum

maximum: number = 90;

lat.minimum

minimum: number = -90;

lat.type

type: "number";

lon

lon: object;

lon.maximum

maximum: number = 180;

lon.minimum

minimum: number = -180;

lon.type

type: "number";

name

name: object;

name.maxLength

maxLength: number = max;

name.minLength?

minLength?: number = min;

name.type

type: "string";

On this page