import Shop from '@eastsideco/escshopify/src/entities/Shop.js'

public class | source

Shop

Extends:

evee → Shop

Shopify Shop entity.

Constructor Summary

Public Constructor
public	constructor() Construct a new instance of the shop entity.

Member Summary

Public Members
public	address: ShopifyAddress
public	collections_count: Number
public	currency: String
public	description: String
public	domain: String
public	email: String
public	enabled_payment_types: String[]
public	locale: String
public	money_format: String
public	money_format_with_currency: String
public	name: String
public	password_message: String
public	permanent_domain: String
public	policies: ShopifyPolicy[]
public	refund_policy: String
public	secure_url: String
public	terms_of_service: String
public	types: String[]
public	url: String
public	vendors: String[]

Method Summary

Public Methods
public	initialize(shopData: ShopifyShop) Initialize the shop entity with the global shop state.
public	makeAbsoluteUrl(relative: String): String Generates an absolute URL containing the shop primary domain.
public	makePermanentUrl(relative: String): String Generates an absolute URL containing the shop's myshopify domain.

Private Methods
private	_loadFromShopifyShop(shop: ShopifyShop) Loads properties from the given shop.
private	_normalizeRelativeUrl(rel: String): String Normalizes a relative URL according to the current pathname.

Public Constructors

public constructor() source

Construct a new instance of the shop entity.

Public Members

public address: ShopifyAddress source

public collections_count: Number source

public currency: String source

public description: String source

public domain: String source

public email: String source

public enabled_payment_types: String[] source

public locale: String source

public money_format: String source

public money_format_with_currency: String source

public name: String source

public password_message: String source

public permanent_domain: String source

public policies: ShopifyPolicy[] source

public refund_policy: String source

public secure_url: String source

public terms_of_service: String source

public types: String[] source

public url: String source

public vendors: String[] source

Public Methods

public initialize(shopData: ShopifyShop) source

Initialize the shop entity with the global shop state.

Params:

Name	Type	Attribute	Description
shopData	ShopifyShop		Shopify shop object.

public makeAbsoluteUrl(relative: String): String source

Generates an absolute URL containing the shop primary domain.

Params:

Name	Type	Attribute	Description
relative	String		A relative URL to make absolute (i.e. '/collections/all')

Return:

String

public makePermanentUrl(relative: String): String source

Generates an absolute URL containing the shop's myshopify domain.

Params:

Name	Type	Attribute	Description
relative	String		A relative URL to make absolute (i.e. '/collections/all')

Return:

String

Private Methods

private _loadFromShopifyShop(shop: ShopifyShop) source

Loads properties from the given shop.

Params:

Name	Type	Attribute	Description
shop	ShopifyShop

private _normalizeRelativeUrl(rel: String): String source

Normalizes a relative URL according to the current pathname.

Params:

Name	Type	Attribute	Description
rel	String

Return:

String