Class StoreDomainService

Hierarchy

StoreDomainService

Index

Constructors

constructor

new StoreDomainService(): StoreDomainService
Returns StoreDomainService

Properties

defaultStoreDomainId

defaultStoreDomainId: number = 1

Methods

doForEachLocale

doForEachLocale<T>(actionFn: ((store: {
    currency: string;
    locale: string;
    storeDomain: string;
    storeDomainId: number;
    storeName: string;
}) => T)): Promise<T[]>
Use this utility to perform async actions on each locale. The actions will be run sequentially and will stop upon any error.
Type Parameters
- T
Parameters
- actionFn: ((store: {
      currency: string;
      locale: string;
      storeDomain: string;
      storeDomainId: number;
      storeName: string;
  }) => T)
  - - (store: {
          currency: string;
          locale: string;
          storeDomain: string;
          storeDomainId: number;
          storeName: string;
      }): T
    - Parameters
      
      store: {
          currency: string;
          locale: string;
          storeDomain: string;
          storeDomainId: number;
          storeName: string;
      }
      
      currency: string
      
      locale: string
      
      storeDomain: string
      
      storeDomainId: number
      
      storeName: string
      
      Returns T
Returns Promise<T[]>
- Defined in storeDomains/service.ts:154

doForEachStore

doForEachStore<T>(actionFn: ((store: {
    currency: string;
    defaultLocale: string;
    description: string;
    storeDomain: string;
    storeDomainId: number;
    storeName: string;
}) => T)): Promise<T[]>
Use this utility to perform async actions on each store. The actions will be run sequentially and will stop upon any error.
Type Parameters
- T
Parameters
- actionFn: ((store: {
      currency: string;
      defaultLocale: string;
      description: string;
      storeDomain: string;
      storeDomainId: number;
      storeName: string;
  }) => T)
  - - (store: {
          currency: string;
          defaultLocale: string;
          description: string;
          storeDomain: string;
          storeDomainId: number;
          storeName: string;
      }): T
    - Parameters
      
      store: {
          currency: string;
          defaultLocale: string;
          description: string;
          storeDomain: string;
          storeDomainId: number;
          storeName: string;
      }
      
      currency: string
      
      defaultLocale: string
      
      description: string
      
      storeDomain: string
      
      storeDomainId: number
      
      storeName: string
      
      Returns T
Returns Promise<T[]>
- Defined in storeDomains/service.ts:115

get

get(__namedParameters: {
    domain?: string;
    locale?: string;
    storeDomainId?: string | number;
}): Promise<Readonly<StoreDomain>>
Use this method to look up a single store domain. It will throw an error if no match is found.
Parameters
- __namedParameters: {
      domain?: string;
      locale?: string;
      storeDomainId?: string | number;
  }
  - Optional domain?: string
  - Optional locale?: string
  - Optional storeDomainId?: string | number
Returns Promise<Readonly<StoreDomain>>
- Defined in storeDomains/service.ts:20

getAll

getAll(): Promise<readonly StoreDomain[]>
Use this method to get all store domains.

Returns Promise<readonly StoreDomain[]>
- Defined in storeDomains/service.ts:52

getDefaultLocale

getDefaultLocale(domainQuery: StoreDomain | {
    currency?: string;
    domain?: string;
    storeDomainId?: string | number;
}): Promise<string>
Use this method to get the default locale for a store domain. It will throw an error if no match is found.
Parameters
- domainQuery: StoreDomain | {
      currency?: string;
      domain?: string;
      storeDomainId?: string | number;
  }
Returns Promise<string>
- Defined in storeDomains/service.ts:60

getLocale

getLocale(__namedParameters: {
locale: string;
}): Promise<undefined | Readonly<StoreLocale>>
Use this method to look up a single store locale.
Parameters
- __namedParameters: {
  locale: string;
  }
  - locale: string
Returns Promise<undefined | Readonly<StoreLocale>>
- Defined in storeDomains/service.ts:96

getLocales

getLocales(): Promise<readonly StoreLocale[]>
Use this method to get all store locales.

Returns Promise<readonly StoreLocale[]>
- Defined in storeDomains/service.ts:107

Class StoreDomainService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns StoreDomainService

Properties

defaultStoreDomainId

Methods

doForEachLocale

Type Parameters

T

Parameters

actionFn: ((store: { currency: string; locale: string; storeDomain: string; storeDomainId: number; storeName: string; }) => T)

Parameters

store: { currency: string; locale: string; storeDomain: string; storeDomainId: number; storeName: string; }

currency: string

locale: string

storeDomain: string

storeDomainId: number

storeName: string

Returns T

Returns Promise<T[]>

doForEachStore

Type Parameters

T

Parameters

actionFn: ((store: { currency: string; defaultLocale: string; description: string; storeDomain: string; storeDomainId: number; storeName: string; }) => T)

Parameters

store: { currency: string; defaultLocale: string; description: string; storeDomain: string; storeDomainId: number; storeName: string; }

currency: string

defaultLocale: string

description: string

storeDomain: string

storeDomainId: number

storeName: string

Returns T

Returns Promise<T[]>

get

Parameters

__namedParameters: { domain?: string; locale?: string; storeDomainId?: string | number; }

Optional domain?: string

Optional locale?: string

Optional storeDomainId?: string | number

Returns Promise<Readonly<StoreDomain>>

getAll

Returns Promise<readonly StoreDomain[]>

getDefaultLocale

Parameters

domainQuery: StoreDomain | { currency?: string; domain?: string; storeDomainId?: string | number; }

Returns Promise<string>

getLocale

Parameters

__namedParameters: { locale: string; }

locale: string

Returns Promise<undefined | Readonly<StoreLocale>>

getLocales

Returns Promise<readonly StoreLocale[]>

Settings

Member Visibility

Theme

actionFn: ((store: {
currency: string;
locale: string;
storeDomain: string;
storeDomainId: number;
storeName: string;
}) => T)

store: {
currency: string;
locale: string;
storeDomain: string;
storeDomainId: number;
storeName: string;
}

actionFn: ((store: {
currency: string;
defaultLocale: string;
description: string;
storeDomain: string;
storeDomainId: number;
storeName: string;
}) => T)

store: {
currency: string;
defaultLocale: string;
description: string;
storeDomain: string;
storeDomainId: number;
storeName: string;
}

__namedParameters: {
domain?: string;
locale?: string;
storeDomainId?: string | number;
}

`Optional` domain?: string

`Optional` locale?: string

`Optional` storeDomainId?: string | number

domainQuery: StoreDomain | {
currency?: string;
domain?: string;
storeDomainId?: string | number;
}

__namedParameters: {
locale: string;
}