@hebcal/rest-api
    Preparing search index...

    Type Alias LocationPlainObj

    JSON-serializable representation of a @hebcal/core Location, as returned by locationToPlainObj(). When locationToPlainObj() is called without a location, only geo: 'none' is set.

    type LocationPlainObj = {
        admin1?: string;
        asciiname?: string;
        cc?: string;
        city?: string | null;
        country?: string;
        elevation?: number;
        geo?: string;
        geonameid?: number;
        latitude?: number;
        longitude?: number;
        state?: string;
        stateName?: string;
        title?: string | null;
        tzid?: string;
        zip?: string;
    }
    Index
    admin1? asciiname? cc? city? country? elevation? geo? geonameid? latitude? longitude? state? stateName? title? tzid? zip?
    admin1?: string

    GeoNames admin1 code (roughly, US state or subnational region)

    asciiname?: string

    ASCII-only spelling of the location name

    cc?: string

    2-letter ISO 3166 country code, e.g. 'US'

    city?: string | null

    short city name, e.g. 'Providence'

    country?: string

    English country name, e.g. 'United States'

    elevation?: number

    elevation in meters, when known

    geo?: string

    geocoding method or source, e.g. 'zip', 'city', or 'none'

    geonameid?: number

    GeoNames.org geonameid

    latitude?: number
    longitude?: number
    state?: string

    2-letter US state abbreviation

    stateName?: string

    full US state name

    title?: string | null

    display name, e.g. 'Providence, RI'

    tzid?: string

    Olson timezone ID, e.g. 'America/New_York'

    zip?: string

    US ZIP code, when the location was looked up by ZIP

    Settings
    Member Visibility

    On This Page
    Properties