@sovereignbase/schema-crdt
    Preparing search index...

    Class CRPostalAddress

    CRDT-backed Schema.org PostalAddress.

    Schema.org: The mailing address.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    "@id": string

    JSON-LD identifier for this node.

    "@type": "PostalAddress"

    Schema.org type name for this node.

    additionalType: Readonly<CRSet<string>>

    Schema.org additionalType: An additional type for the item.

    addressCountry: CRPostalAddressCountry

    Schema.org addressCountry: The country, recommended as ISO 3166-1 alpha-2.

    addressLocality: string

    Schema.org addressLocality: The locality in which the street address is.

    addressRegion: CRPostalAddressRegion

    Schema.org addressRegion: The region in which the locality is.

    alternateName: Readonly<CRSet<string>>

    Schema.org alternateName: An alias for the item.

    areaServed: Readonly<CRSet<CRContactPointAreaServed>>

    Schema.org areaServed: The geographic area where a service or offered item is provided.

    availableLanguage: Readonly<CRSet<CRContactPointAvailableLanguage>>

    Schema.org availableLanguage: A language someone may use with or at the item, service or place.

    contactOption: Readonly<CRSet<CRContactPointContactOption>>

    Schema.org contactOption: An option available on this contact point.

    contactType: string

    Schema.org contactType: The kind of contact point.

    description: Readonly<CRText>

    Schema.org description: A description of the item.

    disambiguatingDescription: Readonly<CRText>

    Schema.org disambiguatingDescription: A short description used to disambiguate the item from other, similar items.

    email: string

    Schema.org email: Email address.

    extendedAddress: string

    Schema.org extendedAddress: An address extension such as an apartment number, C/O or alternative name.

    faxNumber: string

    Schema.org faxNumber: The fax number.

    hoursAvailable: Readonly<CRSet<CRContactPointHoursAvailable>>

    Schema.org hoursAvailable: The hours during which this service or contact is available.

    identifier: Readonly<
        string
        | CRIdReferenceValue
        | CRTypedIdReferenceValue<"PropertyValue">,
    >

    Schema.org identifier.

    image: Readonly<CRSet<CRThingImage>>

    Schema.org image: An image of the item.

    mainEntityOfPage: Readonly<CRSet<CRThingMainEntityOfPage>>

    Schema.org mainEntityOfPage: A page or other CreativeWork for which this thing is the main entity being described.

    name: Readonly<CRText>

    Schema.org name: The name of the item.

    owner: Readonly<CRSet<CRThingOwner>>

    Schema.org owner: A person or organization who owns this Thing.

    postalCode: string

    Schema.org postalCode: The postal code.

    postOfficeBoxNumber: string

    Schema.org postOfficeBoxNumber: The post office box number for PO box addresses.

    potentialAction: Readonly<CRSet<CRThingPotentialAction>>

    Schema.org potentialAction: A potential Action for this Thing.

    productSupported: Readonly<CRSet<CRContactPointProductSupported>>

    Schema.org productSupported: The product or service this support contact point is related to.

    sameAs: Readonly<CRSet<string>>

    Schema.org sameAs: URL of a reference Web page that unambiguously indicates the item's identity.

    streetAddress: string

    Schema.org streetAddress: The street address.

    subjectOf: Readonly<CRSet<CRThingSubjectOf>>

    Schema.org subjectOf: A CreativeWork or Event about this Thing.

    telephone: string

    Schema.org telephone: The telephone number.

    url: string

    Schema.org url: URL of the item.

    Methods

    • Iterates over the current live field entries.

      Returns IterableIterator<
          [
              | "areaServed"
              | "availableLanguage"
              | "contactOption"
              | "contactType"
              | "email"
              | "faxNumber"
              | "hoursAvailable"
              | "productSupported"
              | "telephone"
              | "addressCountry"
              | "addressLocality"
              | "addressRegion"
              | "extendedAddress"
              | "postalCode"
              | "postOfficeBoxNumber"
              | "streetAddress"
              | (keyof CRStructuredValueDefaultShape<"PostalAddress">),

                  | string
                  | CRIdReferenceValue
                  | CRSetSnapshot<string>
                  | CRTextSnapshot
                  | CRTypedIdReferenceValue<"PropertyValue">
                  | CRSetSnapshot<CRThingImage>
                  | CRSetSnapshot<CRThingMainEntityOfPage>
                  | CRSetSnapshot<CRThingOwner>
                  | CRSetSnapshot<CRThingPotentialAction>
                  | CRSetSnapshot<CRThingSubjectOf>
                  | CRTypedIdReferenceValue<"AdministrativeArea">
                  | CRSetSnapshot<CRContactPointAreaServed>
                  | CRSetSnapshot<CRContactPointAvailableLanguage>
                  | CRSetSnapshot<CRContactPointContactOption>
                  | CRSetSnapshot<CRContactPointHoursAvailable>
                  | CRSetSnapshot<CRContactPointProductSupported>
                  | CRTypedIdReferenceValue<"Country">,
          ],
      >

    • Returns cloned key-value pairs for the current replica state.

      Type Parameters

      • K extends
            | "areaServed"
            | "availableLanguage"
            | "contactOption"
            | "contactType"
            | "email"
            | "faxNumber"
            | "hoursAvailable"
            | "productSupported"
            | "telephone"
            | "addressCountry"
            | "addressLocality"
            | "addressRegion"
            | "extendedAddress"
            | "postalCode"
            | "postOfficeBoxNumber"
            | "streetAddress"
            | (keyof CRStructuredValueDefaultShape<"PostalAddress">)

      Returns [K, CRPostalAddressDefaultShape[K]][]

      The current field entries.

    • Removes overwritten identifiers that every provided frontier has acknowledged.

      Parameters

      • frontiers: Partial<
            Record<
                | "areaServed"
                | "availableLanguage"
                | "contactOption"
                | "contactType"
                | "email"
                | "faxNumber"
                | "hoursAvailable"
                | "productSupported"
                | "telephone"
                | "addressCountry"
                | "addressLocality"
                | "addressRegion"
                | "extendedAddress"
                | "postalCode"
                | "postOfficeBoxNumber"
                | "streetAddress"
                | (keyof CRStructuredValueDefaultShape<"PostalAddress">),
                string,
            >,
        >[]

        A collection of acknowledgement frontiers to compact against.

      Returns void

    • Returns the struct field keys.

      Type Parameters

      • K extends
            | "areaServed"
            | "availableLanguage"
            | "contactOption"
            | "contactType"
            | "email"
            | "faxNumber"
            | "hoursAvailable"
            | "productSupported"
            | "telephone"
            | "addressCountry"
            | "addressLocality"
            | "addressRegion"
            | "extendedAddress"
            | "postalCode"
            | "postOfficeBoxNumber"
            | "streetAddress"
            | (keyof CRStructuredValueDefaultShape<"PostalAddress">)

      Returns K[]

      The field keys in the current replica.

    • Applies a remote or local delta to the replica state.

      Parameters

      • crStructDelta:
            | Partial<CRStructSnapshot<CRPostalAddressDefaultShape>>
            | Partial<
                Record<
                    | "areaServed"
                    | "availableLanguage"
                    | "contactOption"
                    | "contactType"
                    | "email"
                    | "faxNumber"
                    | "hoursAvailable"
                    | "productSupported"
                    | "telephone"
                    | "addressCountry"
                    | "addressLocality"
                    | "addressRegion"
                    | "extendedAddress"
                    | "postalCode"
                    | "postOfficeBoxNumber"
                    | "streetAddress"
                    | (keyof CRStructuredValueDefaultShape<"PostalAddress">),
                    unknown,
                >,
            >

        The partial serializable field delta to merge.

      Returns void

    • Parameters

      • key:
            | "areaServed"
            | "availableLanguage"
            | "contactOption"
            | "contactType"
            | "email"
            | "faxNumber"
            | "hoursAvailable"
            | "productSupported"
            | "telephone"
            | "addressCountry"
            | "addressLocality"
            | "addressRegion"
            | "extendedAddress"
            | "postalCode"
            | "postOfficeBoxNumber"
            | "streetAddress"
            | (keyof CRStructuredValueDefaultShape<"PostalAddress">)
      • value: unknown

      Returns void

    • Returns cloned copies of the current field values.

      Type Parameters

      • K extends
            | "areaServed"
            | "availableLanguage"
            | "contactOption"
            | "contactType"
            | "email"
            | "faxNumber"
            | "hoursAvailable"
            | "productSupported"
            | "telephone"
            | "addressCountry"
            | "addressLocality"
            | "addressRegion"
            | "extendedAddress"
            | "postalCode"
            | "postOfficeBoxNumber"
            | "streetAddress"
            | (keyof CRStructuredValueDefaultShape<"PostalAddress">)

      Returns CRPostalAddressDefaultShape[K][]

      The current field values.