Class Place

Hierarchy

default<void, HestiaPlaceData>
- Place

Index

Properties

Accessors

id lat lng name placeData polygon urlLabel

Methods

get toJSON findAll findById findOne suggest

Properties

`Static`serializer

serializer: (model: any) => any

serializer is a pure function that takes a model instance and returns a plain object that describes how to convert the model to JSON

Accessors

id

get id(): string | null
Returns string | null
- Defined in src/api/models/place.ts:91

lat

get lat(): number | null
Returns number | null
- Defined in src/api/models/place.ts:103

lng

get lng(): number | null
Returns number | null
- Defined in src/api/models/place.ts:108

name

get name(): string | null
Returns string | null
- Defined in src/api/models/place.ts:95

placeData

get placeData(): HestiaPlaceData | undefined
Returns HestiaPlaceData | undefined
- Defined in src/api/models/place.ts:118

polygon

get polygon(): string | null
Returns string | null
- Defined in src/api/models/place.ts:113

urlLabel

get urlLabel(): string | null
Returns string | null
- Defined in src/api/models/place.ts:99

Methods

get

get(key: string): any
Retrieves a value from raw API data. Prioritises DBAPI data if available
Parameters
- key: string
Returns any
Inherited from Model.get
- Defined in src/api/models/model.ts:121

toJSON

toJSON(): any
Special method to define behaviour of JSON.stringify() on model instance

Returns any
Inherited from Model.toJSON
- Defined in src/api/models/model.ts:130

`Static`findAll

findAll(
    __namedParameters: { name: string },
): Promise<
    {
        errors: ModelError[]
        | null;
        pagination: Pagination | null;
        results: Place[];
    },
>
Parameters
- __namedParameters: { name: string }
Returns Promise<
    {
        errors: ModelError[]
        | null;
        pagination: Pagination | null;
        results: Place[];
    },
>
- Defined in src/api/models/place.ts:12

`Static`findById

findById(
id: string,
): Promise<{ errors: ModelError[] | null; result: Place | null }>
Parameters
- id: string
Returns Promise<{ errors: ModelError[] | null; result: Place | null }>
- Defined in src/api/models/place.ts:26

`Static`findOne

findOne(
__namedParameters: { name: string },
): Promise<{ errors: ModelError[] | null; result: Place | null }>
Parameters
- __namedParameters: { name: string }
Returns Promise<{ errors: ModelError[] | null; result: Place | null }>
- Defined in src/api/models/place.ts:38

`Static`suggest

suggest(
    __namedParameters: { name: string },
): Promise<
    {
        errors: ModelError[]
        | null;
        results: [string | null, string | null, string | null][] | null;
    },
>
Returns suggestions as a 2d array to be used by autosuggest on frontend
Parameters
- __namedParameters: { name: string }
Returns Promise<
    {
        errors: ModelError[]
        | null;
        results: [string | null, string | null, string | null][] | null;
    },
>
- Defined in src/api/models/place.ts:65