@ordergroove/smi-core / Modules

`smi-core`

Ordergroove's smi library allows you to manage subscription.

Instalation

npm install --save @ordergroove/smi-core

Usage

import { bootstrap } from '@ordergroove/smi-core';
import { mainTemplate } from '@ordergroove/smi-templates';
// bootstrap cookie based auth
bootstrap({ merchant_id: '0e5de2bedc5e11e3a2e4bc764e106cf4', env: 'staging' }, mainTemplate);

// bootstrap json auth
bootstrap({ merchant_id: '0e5de2bedc5e11e3a2e4bc764e106cf4', env: 'staging', auth_url: '/auth' }, mainTemplate);

// bootstrap inline auth
bootstrap(
  {
    auth: {
      public_id: '0e5de2bedc5e11e3a2e4bc764e106cf4',
      ts: 1612805023,
      sig_field: 'TestCust',
      sig: 'bGoeslklKTtlV9l9q16Ah1Md3D21rsegD0x8z2VjvxI='
    },
    env: 'staging'
  },
  mainTemplate
);

// bootstrap inline auth flavor
bootstrap(
  {
    merchant_id: '0e5de2bedc5e11e3a2e4bc764e106cf4',
    auth: 'TestCust|1612805023|bGoeslklKTtlV9l9q16Ah1Md3D21rsegD0x8z2VjvxI=',
    env: 'staging'
  },
  mainTemplate
);

Place the elemenent in the page by either using the legacy markup

<div id="og-msi"></div>

or using latest markup with web components syntax

<og-smi></og-smi>;

bootstrap(config, templateGenerator)

DESCRIPTOR	SUMMARY
config	Object (see below)	Merchant identifier
templateGenerator	Function	Factory of templates

Method that bootstrap the smi for the given configuration and templateGenerator

Configuration

DESCRIPTOR	SUMMARY
merchant_id	Required	Merchant identifier
auth_url	optional	Sets the url that holds the auth object know as ajax auth
auth	optional <object\|string>	Json object containing HMAC auth {sig, sig_field, ts} or string as cookie format
env	defaults=prod oneOf(prod, staging)	Allow to specify staging or production

Templating

Second argument of bootstrap is the templateGenerator

Template generator is a callback that gets call with the lit-html html tag as first argument. Callback need to return a tempalte function that receive the application state.

const templateGenerator = html => state =>
  html`
    <pre>${JSON.stringify(state, null, 4)}</pre>
  `;

const auth = {
  public_id: '0e5de2bedc5e11e3a2e4bc764e106cf4',
  ts: 1634326560,
  sig_field: 'TestCust',
  sig: '674VHI8gVS2eaR0KMzVVmhUNNvrPI7PgQtWHQvJZGmk='
};

bootstrap({ auth }, templateGenerator);

Application State

Name	Type	Desc
locale	String	This value will represent the current locale being set on the website. The value is pulled form the lang attribute of the html node. For example `<html lang='en'>`
customer	Object	This object represents the current customer who is logged into your site that is viewing the SMI
merchant_id	String	This value is used to identify you as the merchant and is the same value that you would find under the customer.public_id key above.
environment	Object	This object represents the environment that the application is currently running in. You typically will not need to
orders	Array	This array represents the list of all of the customer's upcoming orders. Each item in this list is an order object and
items	Array
subscriptions	Array
products	Array
addresses	Array
payments	Array

Local Development

To develop locally run. The command will start smi and templates linked on http://localhost:8080/

lerna bootstrap
lerna run smi:start --parallel

browse http://localhost:8080

Local development also support specifies the bootstrap method params via query string

i.e.
http://localhost:8080/?env=prod&auth=3124365394051|1634324136|ZjRkODA0YTA1OWNkNDE1ZDEzZWM5OWZmZjdlN2NkMzE2YjdjOGJiODM0OTNhZjk1Mjc1ZjI5ZjU1MjhlZTUyYQ==&merchant_id=d6f9f0e8623911ea9fdebc764e10b970

@ordergroove/smi-core / Modules / smi-core / Smi

Class: Smi

smi-core.Smi

Custom element that renders an smi-template

Usage

<og-smi></og-smi>

tag og-smi

Hierarchy

HTMLElement

↳ Smi

Constructors

constructor

• new Smi()

Inherited from

HTMLElement.constructor

Defined in

node_modules/typescript/lib/lib.dom.d.ts:6440

Events

READY

• Static READY: string = 'og:smi:ready'

HTMLElement.DOCUMENT_POSITION_FOLLOWING

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10610

PROCESSING_INSTRUCTION_NODE

• Readonly PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

Inherited from

HTMLElement.PROCESSING_INSTRUCTION_NODE

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10630

TEXT_NODE

baseURI

• Readonly baseURI: string

Returns node's node document's document base URL.

Inherited from

HTMLElement.baseURI

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10495

env

Inherited from

HTMLElement.hidden

Defined in

node_modules/typescript/lib/lib.dom.d.ts:6419

id

isConnected

merchant_id

Type declaration

▸ (ev): any

Fires when the user aborts the download.

Parameters

Name	Type	Description
`ev`	`UIEvent`	The event.

Fires when the object loses the input focus.

Parameters

Name	Type	Description
`ev`	`FocusEvent`	The focus event.

Returns

any

Inherited from

HTMLElement.onblur

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5687

oncanplay

• oncanplay: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when playback is possible, but would require further buffering.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.oncanplay

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5692

oncanplaythrough

• oncanplaythrough: (ev: Event) => any

Type declaration

▸ (ev): any

Parameters

Name	Type
`ev`	`Event`

Returns

any

Inherited from

HTMLElement.oncanplaythrough

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5693

onchange

• onchange: (ev: Event) => any

Type declaration

▸ (ev): any

Fires when the contents of the object or selection have changed.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onchange

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5698

onclick

• onclick: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user clicks the left mouse button on the object

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

Returns

any

Inherited from

HTMLElement.onclick

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5703

onclose

• onclose: (ev: Event) => any

Type declaration

▸ (ev): any

Parameters

Name	Type
`ev`	`Event`

Returns

any

Inherited from

HTMLElement.onclose

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5704

oncontextmenu

• oncontextmenu: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4731

ondblclick

• ondblclick: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user double-clicks the object.

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

Returns

any

Inherited from

HTMLElement.ondblclick

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5715

ondrag

• ondrag: (ev: DragEvent) => any

Type declaration

▸ (ev): any

Fires on the source object continuously during a drag operation.

Parameters

Name	Type	Description
`ev`	`DragEvent`	The event.

Returns

any

Inherited from

HTMLElement.ondrag

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5720

ondragend

• ondragend: (ev: DragEvent) => any

Type declaration

▸ (ev): any

Fires on the source object when the user releases the mouse at the close of a drag operation.

Parameters

Name	Type	Description
`ev`	`DragEvent`	The event.

Returns

any

Inherited from

HTMLElement.ondragend

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5725

ondragenter

• ondragenter: (ev: DragEvent) => any

Type declaration

▸ (ev): any

Fires on the target element when the user drags the object to a valid drop target.

Parameters

Name	Type	Description
`ev`	`DragEvent`	The drag event.

Returns

any

Inherited from

HTMLElement.ondragenter

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5730

ondragleave

• ondragleave: (ev: DragEvent) => any

Type declaration

▸ (ev): any

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

Parameters

Name	Type	Description
`ev`	`DragEvent`	The drag event.

Returns

any

Inherited from

HTMLElement.ondragleave

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5735

ondragover

• ondragover: (ev: DragEvent) => any

Type declaration

▸ (ev): any

Fires on the target element continuously while the user drags the object over a valid drop target.

Parameters

Name	Type	Description
`ev`	`DragEvent`	The event.

Returns

any

Inherited from

HTMLElement.ondragover

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5740

ondragstart

• ondragstart: (ev: DragEvent) => any

Type declaration

▸ (ev): any

Fires on the source object when the user starts to drag a text selection or selected object.

Parameters

Name	Type	Description
`ev`	`DragEvent`	The event.

Returns

any

Inherited from

HTMLElement.ondragstart

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5745

ondrop

• ondrop: (ev: DragEvent) => any

Type declaration

▸ (ev): any

Parameters

Name	Type
`ev`	`DragEvent`

Returns

any

Inherited from

HTMLElement.ondrop

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5746

ondurationchange

• ondurationchange: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the duration attribute is updated.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.ondurationchange

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5751

onemptied

• onemptied: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the media element is reset to its initial state.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onemptied

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5756

onended

• onended: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the end of playback is reached.

Parameters

Name	Type	Description
`ev`	`Event`	The event

Returns

any

Inherited from

HTMLElement.onended

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5761

onerror

• onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

param The event.

Inherited from

HTMLElement.onerror

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5766

onfocus

• onfocus: (ev: FocusEvent) => any

Type declaration

▸ (ev): any

Fires when the object receives focus.

Parameters

Name	Type	Description
`ev`	`FocusEvent`	The event.

Type declaration

▸ (ev): any

Fires when the user presses a key.

Parameters

Name	Type	Description
`ev`	`KeyboardEvent`	The keyboard event

Returns

any

Inherited from

HTMLElement.onkeydown

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5780

onkeypress

• onkeypress: (ev: KeyboardEvent) => any

Type declaration

▸ (ev): any

Fires when the user presses an alphanumeric key.

deprecated

Parameters

Name	Type	Description
`ev`	`KeyboardEvent`	The event.

Returns

any

Inherited from

HTMLElement.onkeypress

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5786

onkeyup

• onkeyup: (ev: KeyboardEvent) => any

Type declaration

▸ (ev): any

Fires when the user releases a key.

Parameters

Name	Type	Description
`ev`	`KeyboardEvent`	The keyboard event

Returns

any

Inherited from

HTMLElement.onkeyup

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5791

onload

• onload: (ev: Event) => any

Type declaration

▸ (ev): any

Fires immediately after the browser loads the object.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onload

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5796

onloadeddata

• onloadeddata: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when media data is loaded at the current playback position.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onloadeddata

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5801

onloadedmetadata

• onloadedmetadata: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the duration and dimensions of the media have been determined.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onloadedmetadata

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5806

onloadstart

• onloadstart: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when Internet Explorer begins looking for media data.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onloadstart

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5811

onlostpointercapture

• onlostpointercapture: (ev: PointerEvent) => any

Type declaration

▸ (ev): any

Parameters

Name	Type
`ev`	`PointerEvent`

Returns

any

Inherited from

HTMLElement.onlostpointercapture

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5812

onmousedown

• onmousedown: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user clicks the object with either mouse button.

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

onmousemove

• onmousemove: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user moves the mouse over the object.

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

Returns

any

Inherited from

HTMLElement.onmousemove

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5824

onmouseout

• onmouseout: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user moves the mouse pointer outside the boundaries of the object.

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

Returns

any

Inherited from

HTMLElement.onmouseout

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5829

onmouseover

• onmouseover: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user moves the mouse pointer into the object.

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

Returns

any

Inherited from

HTMLElement.onmouseover

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5834

onmouseup

• onmouseup: (ev: MouseEvent) => any

Type declaration

▸ (ev): any

Fires when the user releases a mouse button while the mouse is over the object.

Parameters

Name	Type	Description
`ev`	`MouseEvent`	The mouse event.

Returns

any

Inherited from

HTMLElement.onmouseup

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5839

onpaste

• onpaste: (ev: ClipboardEvent) => any

Type declaration

▸ (ev): any

Parameters

Name	Type
`ev`	`ClipboardEvent`

Returns

any

Inherited from

HTMLElement.onpaste

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4732

onpause

• onpause: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when playback is paused.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onpause

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5844

onplay

• onplay: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the play method is requested.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onplay

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5849

onplaying

• onplaying: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the audio or video has started playing.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5862

onprogress

• onprogress: (ev: ProgressEvent<EventTarget>) => any

Type declaration

▸ (ev): any

Occurs to indicate progress while downloading media data.

Parameters

Name	Type	Description
`ev`	`ProgressEvent`<`EventTarget`>	The event.

Returns

any

Inherited from

HTMLElement.onprogress

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5867

onratechange

• onratechange: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the playback rate is increased or decreased.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onratechange

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5872

onreset

• onreset: (ev: Event) => any

Type declaration

▸ (ev): any

Fires when the user resets a form.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onreset

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5877

onresize

• onresize: (ev: UIEvent) => any

Type declaration

▸ (ev): any

Parameters

Name	Type
`ev`	`UIEvent`

Returns

any

Inherited from

HTMLElement.onresize

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5878

onscroll

• onscroll: (ev: Event) => any

Type declaration

▸ (ev): any

Fires when the user repositions the scroll box in the scroll bar on the object.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onscroll

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5883

onseeked

• onseeked: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the seek operation ends.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onseeked

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5888

onseeking

• onseeking: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the current playback position is moved.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onseeking

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5893

onselect

• onselect: (ev: Event) => any

Type declaration

▸ (ev): any

Fires when the current selection changes.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

onstalled

• onstalled: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the download has stopped.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onstalled

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5905

onsubmit

• onsubmit: (ev: Event) => any

Type declaration

▸ (ev): any

Parameters

Name	Type
`ev`	`Event`

Returns

any

Inherited from

HTMLElement.onsubmit

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5906

onsuspend

• onsuspend: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs if the load operation has been intentionally halted.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onsuspend

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5911

ontimeupdate

• ontimeupdate: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs to indicate the current playback position.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Inherited from

HTMLElement.ontransitionstart

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5925

onvolumechange

• onvolumechange: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when the volume is changed, or playback is muted or unmuted.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

Returns

any

Inherited from

HTMLElement.onvolumechange

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5930

onwaiting

• onwaiting: (ev: Event) => any

Type declaration

▸ (ev): any

Occurs when playback stops because the next frame of a video resource is not available.

Parameters

Name	Type	Description
`ev`	`Event`	The event.

shadowRoot

• Readonly shadowRoot: ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

Inherited from

HTMLElement.shadowRoot

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4914

slot

tagName

store

▪ Static store: SmiStore = store

Defines the glbal redux store

Defined in

packages/smi-core/src/components/Smi.js:61

Accessors

store

• get store(): SmiStore

Returns the instance of redux store

Returns

SmiStore

Defined in

packages/smi-core/src/components/Smi.js:131

template

• set template(templateGenerator): void

Sets template for current smi instance

The following example ilustrates a smi template that renders all state as JSON string

document.querySelector('og-smi').templatye = html => state => html`<pre>${JSON.stringify(state,null,4)}</pre>`

Parameters

Name	Type
`templateGenerator`	(`html`: `Function`) => (`state`: `SmiState`) => `TemplateResult`

Returns

void

Defined in

packages/smi-core/src/components/Smi.js:84

template

• Static set template(val): void

Sets the default template for all smi instaces

Parameters

Name	Type
`val`	`any`

Returns

void

Defined in

packages/smi-core/src/components/Smi.js:66

Methods

addEventListener

▸ addEventListener<K>(type, listener, options?): void

Type parameters

Name	Type
`K`	extends keyof `HTMLElementEventMap`

Parameters

Name	Type
`type`	`K`
`listener`	(`ev`: `HTMLElementEventMap`[`K`]) => `any`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

HTMLElement.addEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:6432

▸ addEventListener(type, listener, options?): void

Parameters

Name	Type
`type`	`string`
`listener`	`EventListenerOrEventListenerObject`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

HTMLElement.addEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:6433

after

▸ after(...nodes): void

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

Name	Type
`...nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

HTMLElement.after

Defined in

node_modules/typescript/lib/lib.dom.d.ts:3491

animate

▸ animate(keyframes, options?): Animation

Parameters

Name	Type
`keyframes`	`Keyframe`[] \| `PropertyIndexedKeyframes`
`options?`	`number` \| `KeyframeAnimationOptions`

Returns

Animation

Inherited from

HTMLElement.animate

Defined in

node_modules/typescript/lib/lib.dom.d.ts:1996

append

▸ append(...nodes): void

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

Name	Type
`...nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

HTMLElement.append

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10976

appendChild

▸ appendChild<T>(node): T

Type parameters

Name	Type
`T`	extends `Node`

Parameters

Name	Type
`node`	`T`

Returns

T

Inherited from

HTMLElement.appendChild

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10542

attachShadow

▸ attachShadow(init): ShadowRoot

Creates a shadow root for element and returns it.

Parameters

Name	Type
`init`	`ShadowRootInit`

Returns

ShadowRoot

Inherited from

HTMLElement.attachShadow

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4926

before

▸ before(...nodes): void

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

Name	Type
`...nodes`	(`string` \| `Node`)[]

Returns a copy of node. If deep is true, the copy also includes the node's descendants.

Parameters

Name	Type
`deep?`	`boolean`

Returns

Node

Inherited from

HTMLElement.cloneNode

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10546

closest

▸ closest<K>(selector): HTMLElementTagNameMap[K]

Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

Type parameters

Name	Type
`K`	extends keyof `HTMLElementTagNameMap`

Parameters

Name	Type
`selector`	`K`

Returns

HTMLElementTagNameMap[K]

Inherited from

HTMLElement.closest

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4930

▸ closest<K>(selector): SVGElementTagNameMap[K]

Type parameters

Name	Type
`K`	extends keyof `SVGElementTagNameMap`

Parameters

Name	Type
`selector`	`K`

Returns

SVGElementTagNameMap[K]

Inherited from

HTMLElement.closest

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4931

▸ closest<E>(selectors): E

Type parameters

Name	Type
`E`	extends Element``Element

Parameters

Name	Type
`selectors`	`string`

Returns

E

Inherited from

HTMLElement.closest

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4932

compareDocumentPosition

▸ compareDocumentPosition(other): number

Returns a bitmask indicating the position of other relative to node.

Parameters

Name	Type
`other`	`Node`

Returns

number

Inherited from

HTMLElement.compareDocumentPosition

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10550

contains

▸ contains(other): boolean

Returns true if other is an inclusive descendant of node, and false otherwise.

Parameters

Name	Type
`other`	`Node`

Returns

boolean

Inherited from

HTMLElement.contains

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10554

dispatchEvent

▸ dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters

Name	Type
`event`	`Event`

Defined in

node_modules/typescript/lib/lib.dom.d.ts:1997

getAttribute

▸ getAttribute(qualifiedName): string

Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

Parameters

Name	Type
`qualifiedName`	`string`

Returns

string

Inherited from

HTMLElement.getAttribute

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4936

getAttributeNS

▸ getAttributeNS(namespace, localName): string

Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

Parameters

Name	Type
`namespace`	`string`
`localName`	`string`

Returns

string

Inherited from

HTMLElement.getAttributeNS

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4940

getAttributeNames

▸ getAttributeNames(): string[]

HTMLElement.getClientRects

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4948

getElementsByClassName

▸ getElementsByClassName(classNames): HTMLCollectionOf<Element>

Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

Parameters

Name	Type
`classNames`	`string`

Returns

HTMLCollectionOf<Element>

Inherited from

HTMLElement.getElementsByClassName

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4952

getElementsByTagName

▸ getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>

Type parameters

Name	Type
`K`	extends keyof `HTMLElementTagNameMap`

Parameters

Name	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf<HTMLElementTagNameMap[K]>

Inherited from

HTMLElement.getElementsByTagName

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4953

▸ getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>

Type parameters

Name	Type
`K`	extends keyof `SVGElementTagNameMap`

Parameters

Name	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf<SVGElementTagNameMap[K]>

Inherited from

HTMLElement.getElementsByTagName

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4954

▸ getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

Parameters

Name	Type
`qualifiedName`	`string`

Returns

HTMLCollectionOf<Element>

Inherited from

HTMLElement.getElementsByTagName

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4955

getElementsByTagNameNS

▸ getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

Parameters

Name	Type
`namespaceURI`	`"http://www.w3.org/1999/xhtml"`
`localName`	`string`

Returns

HTMLCollectionOf<HTMLElement>

Inherited from

HTMLElement.getElementsByTagNameNS

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4956

▸ getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

Parameters

Name	Type
`namespaceURI`	`"http://www.w3.org/2000/svg"`
`localName`	`string`

Returns

HTMLCollectionOf<SVGElement>

Inherited from

HTMLElement.getElementsByTagNameNS

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4957

▸ getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

Parameters

Name	Type
`namespace`	`string`
`localName`	`string`

Returns

HTMLCollectionOf<Element>

Inherited from

HTMLElement.getElementsByTagNameNS

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4958

getRootNode

▸ getRootNode(options?): Node

Returns node's root.

Parameters

Name	Type
`options?`	`GetRootNodeOptions`

Returns

Node

Inherited from

HTMLElement.getRootNode

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10558

hasAttribute

▸ hasAttribute(qualifiedName): boolean

Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

Parameters

Name	Type
`qualifiedName`	`string`

Returns

boolean

Inherited from

HTMLElement.hasAttribute

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4962

hasAttributeNS

▸ hasAttributeNS(namespace, localName): boolean

Returns true if element has an attribute whose namespace is namespace and local name is localName.

Parameters

Name	Type
`namespace`	`string`
`localName`	`string`

Returns

boolean

Inherited from

HTMLElement.hasAttributeNS

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4966

hasAttributes

▸ hasAttributes(): boolean

Returns true if element has attributes, and false otherwise.

Returns

boolean

Inherited from

HTMLElement.hasAttributes

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4970

hasChildNodes

▸ hasChildNodes(): boolean

Name	Type
`T`	extends `Node`

Parameters

Name	Type
`node`	`T`
`child`	`Node`

Returns

T

Inherited from

HTMLElement.insertBefore

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10563

isDefaultNamespace

▸ isDefaultNamespace(namespace): boolean

Parameters

Name	Type
`namespace`	`string`

Returns

boolean

Inherited from

HTMLElement.isDefaultNamespace

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10564

isEqualNode

▸ isEqualNode(otherNode): boolean

Returns whether node and otherNode have the same properties.

Parameters

Name	Type
`otherNode`	`Node`

Inherited from

HTMLElement.lookupPrefix

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10571

matches

▸ matches(selectors): boolean

Returns true if matching selectors against element's root yields element, and false otherwise.

Parameters

Name	Type
`selectors`	`string`

Returns

boolean

Inherited from

HTMLElement.matches

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4978

normalize

▸ normalize(): void

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

Returns

void

Inherited from

HTMLElement.normalize

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10575

prepend

▸ prepend(...nodes): void

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

Name	Type
`...nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

HTMLElement.prepend

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10982

querySelector

▸ querySelector<K>(selectors): HTMLElementTagNameMap[K]

Returns the first element that is a descendant of node that matches selectors.

Type parameters

Name	Type
`K`	extends keyof `HTMLElementTagNameMap`

Parameters

Name	Type
`selectors`	`K`

Returns

HTMLElementTagNameMap[K]

Inherited from

HTMLElement.querySelector

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10986

▸ querySelector<K>(selectors): SVGElementTagNameMap[K]

Type parameters

Name	Type
`K`	extends keyof `SVGElementTagNameMap`

Parameters

Name	Type
`selectors`	`K`

Returns

SVGElementTagNameMap[K]

Inherited from

HTMLElement.querySelector

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10987

▸ querySelector<E>(selectors): E

Type parameters

Name	Type
`E`	extends Element``Element

Parameters

Name	Type
`selectors`	`string`

Returns

E

Inherited from

HTMLElement.querySelector

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10988

querySelectorAll

▸ querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>

Returns all element descendants of node that match selectors.

Type parameters

Name	Type
`K`	extends keyof `HTMLElementTagNameMap`

Parameters

Name	Type
`selectors`	`K`

Returns

NodeListOf<HTMLElementTagNameMap[K]>

Inherited from

HTMLElement.querySelectorAll

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10992

▸ querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>

Type parameters

Name	Type
`K`	extends keyof `SVGElementTagNameMap`

Parameters

Name	Type
`selectors`	`K`

Returns

NodeListOf<SVGElementTagNameMap[K]>

Inherited from

HTMLElement.querySelectorAll

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10993

▸ querySelectorAll<E>(selectors): NodeListOf<E>

Type parameters

Name	Type
`E`	extends Element``Element

Parameters

Name	Type
`selectors`	`string`

Returns

NodeListOf<E>

Inherited from

HTMLElement.querySelectorAll

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10994

releasePointerCapture

▸ releasePointerCapture(pointerId): void

Parameters

Name	Type
`pointerId`	`number`

Returns

void

Inherited from

HTMLElement.releasePointerCapture

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4979

remove

▸ remove(): void

Removes node.

Returns

void

Inherited from

HTMLElement.remove

Defined in

node_modules/typescript/lib/lib.dom.d.ts:3501

removeAttribute

▸ removeAttribute(qualifiedName): void

Removes element's first attribute whose qualified name is qualifiedName.

Parameters

Name	Type
`qualifiedName`	`string`

Returns

void

Inherited from

HTMLElement.removeAttribute

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4983

removeAttributeNS

▸ removeAttributeNS(namespace, localName): void

Removes element's attribute whose namespace is namespace and local name is localName.

Parameters

Name	Type
`namespace`	`string`
`localName`	`string`

Returns

void

Inherited from

HTMLElement.removeAttributeNS

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4987

removeAttributeNode

▸ removeAttributeNode(attr): Attr

Parameters

Name	Type
`attr`	`Attr`

Returns

Attr

Inherited from

HTMLElement.removeAttributeNode

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4988

removeChild

▸ removeChild<T>(child): T

Type parameters

Name	Type
`T`	extends `Node`

Parameters

Name	Type
`child`	`T`

Returns

T

Inherited from

HTMLElement.removeChild

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10576

removeEventListener

▸ removeEventListener<K>(type, listener, options?): void

Type parameters

Name	Type
`K`	extends keyof `HTMLElementEventMap`

Parameters

Name	Type
`type`	`K`
`listener`	(`ev`: `HTMLElementEventMap`[`K`]) => `any`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

HTMLElement.removeEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:6434

▸ removeEventListener(type, listener, options?): void

Parameters

Name	Type
`type`	`string`
`listener`	`EventListenerOrEventListenerObject`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

HTMLElement.removeEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:6435

replaceChild

▸ replaceChild<T>(node, child): T

Type parameters

Name	Type
`T`	extends `Node`

Parameters

Name	Type
`node`	`Node`
`child`	`T`

Returns

T

Inherited from

HTMLElement.replaceChild

Defined in

node_modules/typescript/lib/lib.dom.d.ts:10577

replaceChildren

▸ replaceChildren(...nodes): void

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

Name	Type
`...nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

HTMLElement.replaceChildren

Defined in

node_modules/typescript/lib/lib.dom.d.ts:11000

replaceWith

▸ replaceWith(...nodes): void

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

Name	Type
`...nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

HTMLElement.replaceWith

Defined in

node_modules/typescript/lib/lib.dom.d.ts:3507

requestFullscreen

▸ requestFullscreen(options?): Promise<void>

Displays element fullscreen and resolves promise when done.

When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

Parameters

Name	Type
`options?`	`FullscreenOptions`

▸ scroll(x, y): void

Parameters

Name	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

HTMLElement.scroll

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4997

scrollBy

▸ scrollBy(options?): void

Parameters

Name	Type
`options?`	`ScrollToOptions`

Returns

void

Inherited from

HTMLElement.scrollBy

Defined in

node_modules/typescript/lib/lib.dom.d.ts:4998

▸ scrollBy(x, y): void

Parameters

Name	Type
`x`	`number`
`y`	`number`

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5001

▸ scrollTo(x, y): void

Parameters

Name	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

HTMLElement.scrollTo

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5002

setAttribute

▸ setAttribute(qualifiedName, value): void

Sets the value of element's first attribute whose qualified name is qualifiedName to value.

Parameters

Name	Type
`qualifiedName`	`string`
`value`	`string`

Returns

void

Inherited from

HTMLElement.setAttribute

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5006

setAttributeNS

▸ setAttributeNS(namespace, qualifiedName, value): void

Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

Parameters

Name	Type
`namespace`	`string`
`qualifiedName`	`string`
`value`	`string`

webkitMatchesSelector

▸ webkitMatchesSelector(selectors): boolean

deprecated This is a legacy alias of matches.

Parameters

Name	Type
`selectors`	`string`

Returns

boolean

Inherited from

HTMLElement.webkitMatchesSelector

Defined in

node_modules/typescript/lib/lib.dom.d.ts:5021

@ordergroove/smi-core / Modules / smi-core / dayjs / Dayjs

Class: Dayjs

smi-core.dayjs.Dayjs

Constructors

constructor

Methods

add
clone
date
day
daysInMonth
diff
endOf
format
get
hour
isAfter
isBefore
isSame
isValid
locale
millisecond
minute
month
second
set
startOf
subtract
toDate
toISOString
toJSON
toString
unix
utcOffset
valueOf
year

Constructors

constructor

• new Dayjs(config?)

Parameters

Name	Type
`config?`	`ConfigType`

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:28

Methods

add

▸ add(value, unit?): Dayjs

Returns a cloned Day.js object with a specified amount of time added.

dayjs().add(7, 'day')// => Dayjs

Units are case insensitive, and support plural and short forms.

Docs: https://day.js.org/docs/en/manipulate/add

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |
| `unit?` | [`OpUnitType`](#opunittype) |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:234

___

### clone

▸ **clone**(): [`Dayjs`](#classessmi_coredayjsdayjsmd)

All Day.js objects are immutable. Still, `dayjs#clone` can create a clone of the current object if you need one.

dayjs().clone()// => Dayjs
dayjs(dayjs('2019-01-25')) // passing a Dayjs object to a constructor will also clone it

Docs: https://day.js.org/docs/en/parse/dayjs-clone

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:37

___

### date

▸ **date**(): `number`

Get the date of the month.

dayjs().date()// => 1-31

Docs: https://day.js.org/docs/en/get-set/date

Accepts numbers from 1 to 31. If the range is exceeded, it will bubble up to the months.

dayjs().date(1)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/date

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:91

▸ **date**(`value`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Set the date of the month.

Accepts numbers from 1 to 31. If the range is exceeded, it will bubble up to the months.

dayjs().date(1)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/date

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:101

___

### day

▸ **day**(): `number`

Get the day of the week.

Returns numbers from 0 (Sunday) to 6 (Saturday).

dayjs().day()// 0-6

Docs: https://day.js.org/docs/en/get-set/day

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:111

▸ **day**(`value`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Set the day of the week.

Accepts numbers from 0 (Sunday) to 6 (Saturday). If the range is exceeded, it will bubble up to other weeks.

dayjs().day(0)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/day

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:121

___

### daysInMonth

▸ **daysInMonth**(): `number`

Get the number of days in the current month.

dayjs('2019-01-25').daysInMonth() // 31

Docs: https://day.js.org/docs/en/display/days-in-month

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:324

___

### diff

▸ **diff**(`date`, `unit?`, `float?`): `number`

This indicates the difference between two date-time in the specified unit.

To get the difference in milliseconds, use `dayjs#diff`

const date1 = dayjs('2019-01-25')
const date2 = dayjs('2018-06-05')
date1.diff(date2) // 20214000000 default milliseconds

To get the difference in another unit of measurement, pass that measurement as the second argument.

const date1 = dayjs('2019-01-25')
date1.diff('2018-06-05', 'month') // 7

Units are case insensitive, and support plural and short forms.

Docs: https://day.js.org/docs/en/display/difference

#### Parameters

| Name | Type |
| :------ | :------ |
| `date` | [`ConfigType`](#configtype) |
| `unit?` | ``"s"`` \| ``"millisecond"`` \| ``"second"`` \| ``"minute"`` \| ``"hour"`` \| ``"day"`` \| ``"month"`` \| ``"year"`` \| ``"date"`` \| ``"milliseconds"`` \| ``"seconds"`` \| ``"minutes"`` \| ``"hours"`` \| ``"days"`` \| ``"months"`` \| ``"years"`` \| ``"dates"`` \| ``"d"`` \| ``"M"`` \| ``"y"`` \| ``"h"`` \| ``"m"`` \| ``"ms"`` \| ``"week"`` \| ``"weeks"`` \| ``"w"`` \| ``"quarter"`` \| ``"quarters"`` \| ``"Q"`` |
| `float?` | `boolean` |

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:295

___

### endOf

▸ **endOf**(`unit`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Returns a cloned Day.js object and set it to the end of a unit of time.

dayjs().endOf('month')// => Dayjs

Units are case insensitive, and support plural and short forms.

Docs: https://day.js.org/docs/en/manipulate/end-of

#### Parameters

| Name | Type |
| :------ | :------ |
| `unit` | [`OpUnitType`](#opunittype) |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:264

___

### format

▸ **format**(`template?`): `string`

Get the formatted date according to the string of tokens passed in.

To escape characters, wrap them in square brackets (e.g. [MM]).

dayjs().format()// => current date in ISO8601, without fraction seconds e.g. '2020-04-02T08:02:17-05:00'
dayjs('2019-01-25').format('[YYYYescape] YYYY-MM-DDTHH:mm:ssZ[Z]')// 'YYYYescape 2019-01-25T00:00:00-02:00Z'
dayjs('2019-01-25').format('DD/MM/YYYY') // '25/01/2019'

Docs: https://day.js.org/docs/en/display/format

#### Parameters

| Name | Type |
| :------ | :------ |
| `template?` | `string` |

#### Returns

`string`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:276

___

### get

▸ **get**(`unit`): `number`

String getter, returns the corresponding information getting from Day.js object.

In general:

dayjs().get(unit) === dayjs()[unit]()

Units are case insensitive, and support plural and short forms.

dayjs().get('year')
dayjs().get('month') // start 0
dayjs().get('date')

Docs: https://day.js.org/docs/en/get-set/get

#### Parameters

| Name | Type |
| :------ | :------ |
| `unit` | [`UnitType`](#unittype) |

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:224

___

### hour

▸ **hour**(): `number`

Get the hour.

dayjs().hour()// => 0-23

Docs: https://day.js.org/docs/en/get-set/hour

Accepts numbers from 0 to 23. If the range is exceeded, it will bubble up to the day.

dayjs().hour(12)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/hour

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:129

▸ **hour**(`value`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Set the hour.

Accepts numbers from 0 to 23. If the range is exceeded, it will bubble up to the day.

dayjs().hour(12)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/hour

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:139

___

### isAfter

▸ **isAfter**(`date`, `unit?`): `boolean`

This indicates whether the Day.js object is after the other supplied date-time.

dayjs().isAfter(dayjs('2011-01-01')) // default milliseconds

If you want to limit the granularity to a unit other than milliseconds, pass it as the second parameter.

dayjs().isAfter('2011-01-01', 'year')// => boolean

Units are case insensitive, and support plural and short forms.

Docs: https://day.js.org/docs/en/query/is-after

#### Parameters

| Name | Type |
| :------ | :------ |
| `date` | [`ConfigType`](#configtype) |
| `unit?` | [`OpUnitType`](#opunittype) |

#### Returns

`boolean`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:403

___

### isBefore

▸ **isBefore**(`date`, `unit?`): `boolean`

This indicates whether the Day.js object is before the other supplied date-time.

dayjs().isBefore(dayjs('2011-01-01')) // default milliseconds

If you want to limit the granularity to a unit other than milliseconds, pass it as the second parameter.

dayjs().isBefore('2011-01-01', 'year')// => boolean

Units are case insensitive, and support plural and short forms.

Docs: https://day.js.org/docs/en/query/is-before

#### Parameters

| Name | Type |
| :------ | :------ |
| `date` | [`ConfigType`](#configtype) |
| `unit?` | [`OpUnitType`](#opunittype) |

#### Returns

`boolean`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:377

___

### isSame

▸ **isSame**(`date`, `unit?`): `boolean`

This indicates whether the Day.js object is the same as the other supplied date-time.

dayjs().isSame(dayjs('2011-01-01')) // default milliseconds

If you want to limit the granularity to a unit other than milliseconds, pass it as the second parameter.

dayjs().isSame('2011-01-01', 'year')// => boolean

Docs: https://day.js.org/docs/en/query/is-same

#### Parameters

| Name | Type |
| :------ | :------ |
| `date` | [`ConfigType`](#configtype) |
| `unit?` | [`OpUnitType`](#opunittype) |

#### Returns

`boolean`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:389

___

### isValid

▸ **isValid**(): `boolean`

This returns a `boolean` indicating whether the Day.js object contains a valid date or not.

dayjs().isValid()// => boolean

Docs: https://day.js.org/docs/en/parse/is-valid

#### Returns

`boolean`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:45

___

### locale

▸ **locale**(): `string`

#### Returns

`string`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:405

▸ **locale**(`preset`, `object?`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Parameters

| Name | Type |
| :------ | :------ |
| `preset` | `string` \| `ILocale` |
| `object?` | `Partial`<`ILocale`\> |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:407

___

### millisecond

▸ **millisecond**(): `number`

Get the milliseconds.

dayjs().millisecond()// => 0-999

Docs: https://day.js.org/docs/en/get-set/millisecond

Accepts numbers from 0 to 999. If the range is exceeded, it will bubble up to the seconds.

dayjs().millisecond(1)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/millisecond

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:182

▸ **millisecond**(`value`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Set the milliseconds.

Accepts numbers from 0 to 999. If the range is exceeded, it will bubble up to the seconds.

dayjs().millisecond(1)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/millisecond

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:192

___

### minute

▸ **minute**(): `number`

Get the minutes.

dayjs().minute()// => 0-59

Docs: https://day.js.org/docs/en/get-set/minute

Accepts numbers from 0 to 59. If the range is exceeded, it will bubble up to the hour.

dayjs().minute(59)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/minute

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:147

▸ **minute**(`value`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Set the minutes.

Accepts numbers from 0 to 59. If the range is exceeded, it will bubble up to the hour.

dayjs().minute(59)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/minute

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:157

___

### month

▸ **month**(): `number`

Get the month.

Months are zero indexed, so January is month 0.

dayjs().month()// => 0-11

Docs: https://day.js.org/docs/en/get-set/month

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:71

▸ **month**(`value`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Set the month.

Months are zero indexed, so January is month 0.

Accepts numbers from 0 to 11. If the range is exceeded, it will bubble up to the year.

dayjs().month(0)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/month

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:83

___

### second

▸ **second**(): `number`

Get the seconds.

dayjs().second()// => 0-59

Docs: https://day.js.org/docs/en/get-set/second

Accepts numbers from 0 to 59. If the range is exceeded, it will bubble up to the minutes.

dayjs().second(1)// Dayjs

Returns

number

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:165

▸ second(value): Dayjs

Set the seconds.

Accepts numbers from 0 to 59. If the range is exceeded, it will bubble up to the minutes.

dayjs().second(1)// Dayjs

Parameters

Name	Type
`value`	`number`

Returns

Dayjs

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:174

set

▸ set(unit, value): Dayjs

Generic setter, accepting unit as first argument, and value as second, returns a new instance with the applied changes.

In general:

dayjs().set(unit, value) === dayjs()[unit](value)

Units are case insensitive, and support plural and short forms.

dayjs().set('date', 1)
dayjs().set('month', 3) // April
dayjs().set('second', 30)

Docs: https://day.js.org/docs/en/get-set/set

#### Parameters

| Name | Type |
| :------ | :------ |
| `unit` | [`UnitType`](#unittype) |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:208

___

### startOf

▸ **startOf**(`unit`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Returns a cloned Day.js object and set it to the start of a unit of time.

dayjs().startOf('year')// => Dayjs

Units are case insensitive, and support plural and short forms.

Docs: https://day.js.org/docs/en/manipulate/start-of

#### Parameters

| Name | Type |
| :------ | :------ |
| `unit` | [`OpUnitType`](#opunittype) |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:254

___

### subtract

▸ **subtract**(`value`, `unit?`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Returns a cloned Day.js object with a specified amount of time subtracted.

dayjs().subtract(7, 'year')// => Dayjs

Units are case insensitive, and support plural and short forms.

Docs: https://day.js.org/docs/en/manipulate/subtract

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |
| `unit?` | [`OpUnitType`](#opunittype) |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:244

___

### toDate

▸ **toDate**(): `Date`

To get a copy of the native `Date` object parsed from the Day.js object use `dayjs#toDate`.

dayjs('2019-01-25').toDate()// => Date

Returns

Date

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:331

toISOString

▸ toISOString(): string

To format as an ISO 8601 string.

dayjs('2019-01-25').toISOString() // '2019-01-25T02:00:00.000Z'

Docs: https://day.js.org/docs/en/display/as-iso-string

#### Returns

`string`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:347

___

### toJSON

▸ **toJSON**(): `string`

To serialize as an ISO 8601 string.

dayjs('2019-01-25').toJSON() // '2019-01-25T02:00:00.000Z'

Docs: https://day.js.org/docs/en/display/as-json

#### Returns

`string`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:339

___

### toString

▸ **toString**(): `string`

Returns a string representation of the date.

dayjs('2019-01-25').toString() // 'Fri, 25 Jan 2019 02:00:00 GMT'

Docs: https://day.js.org/docs/en/display/as-string

#### Returns

`string`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:355

___

### unix

▸ **unix**(): `number`

This returns the Unix timestamp (the number of **seconds** since the Unix Epoch) of the Day.js object.

dayjs('2019-01-25').unix() // 1548381600

This value is floored to the nearest second, and does not include a milliseconds component.

Docs: https://day.js.org/docs/en/display/unix-timestamp

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:316

___

### utcOffset

▸ **utcOffset**(): `number`

Get the UTC offset in minutes.

dayjs().utcOffset()

Docs: https://day.js.org/docs/en/manipulate/utc-offset

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:363

___

### valueOf

▸ **valueOf**(): `number`

This returns the number of **milliseconds** since the Unix Epoch of the Day.js object.

dayjs('2019-01-25').valueOf() // 1548381600000
+dayjs(1548381600000) // 1548381600000

To get a Unix timestamp (the number of seconds since the epoch) from a Day.js object, you should use Unix Timestamp `dayjs#unix()`.

Docs: https://day.js.org/docs/en/display/unix-timestamp-milliseconds

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:306

___

### year

▸ **year**(): `number`

Get the year.

dayjs().year()// => 2020

Docs: https://day.js.org/docs/en/get-set/year

#### Returns

`number`

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:53

▸ **year**(`value`): [`Dayjs`](#classessmi_coredayjsdayjsmd)

Set the year.

dayjs().year(2000)// => Dayjs

Docs: https://day.js.org/docs/en/get-set/year

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `number` |

#### Returns

[`Dayjs`](#classessmi_coredayjsdayjsmd)

#### Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:61


<a name="enumstypescancelreasonmd"></a>

[@ordergroove/smi-core](#readmemd) / [Modules](#modulesmd) / [types](#modulestypesmd) / CancelReason

# Enumeration: CancelReason

[types](#modulestypesmd).CancelReason

## Table of contents

### Enumeration members

- [CANCEL\_REASON\_1](#cancel_reason_1)
- [CANCEL\_REASON\_15](#cancel_reason_15)
- [CANCEL\_REASON\_2](#cancel_reason_2)
- [CANCEL\_REASON\_22](#cancel_reason_22)
- [CANCEL\_REASON\_3](#cancel_reason_3)
- [CANCEL\_REASON\_31](#cancel_reason_31)
- [CANCEL\_REASON\_70](#cancel_reason_70)
- [CANCEL\_REASON\_8](#cancel_reason_8)

## Enumeration members

### CANCEL\_REASON\_1

• **CANCEL\_REASON\_1** = `"Other (please specify)"`

#### Defined in

[packages/smi-core/src/types/index.ts:874](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L874)

___

### CANCEL\_REASON\_15

• **CANCEL\_REASON\_15** = `"I don't like this product"`

#### Defined in

[packages/smi-core/src/types/index.ts:878](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L878)

___

### CANCEL\_REASON\_2

• **CANCEL\_REASON\_2** = `"I have too many of this product"`

#### Defined in

[packages/smi-core/src/types/index.ts:875](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L875)

___

### CANCEL\_REASON\_22

• **CANCEL\_REASON\_22** = `"I wanted to switch to a different product/flavor"`

#### Defined in

[packages/smi-core/src/types/index.ts:879](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L879)

___

### CANCEL\_REASON\_3

• **CANCEL\_REASON\_3** = `"I stopped using this product"`

#### Defined in

[packages/smi-core/src/types/index.ts:876](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L876)

___

### CANCEL\_REASON\_31

• **CANCEL\_REASON\_31** = `"I had trouble managing my subscription"`

#### Defined in

[packages/smi-core/src/types/index.ts:880](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L880)

___

### CANCEL\_REASON\_70

• **CANCEL\_REASON\_70** = `"I no longer have any use for this product and I will not need it in the near future"`

#### Defined in

[packages/smi-core/src/types/index.ts:881](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L881)

___

### CANCEL\_REASON\_8

• **CANCEL\_REASON\_8** = `"This product is too expensive"`

#### Defined in

[packages/smi-core/src/types/index.ts:877](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L877)


<a name="enumstypescctypemd"></a>

[@ordergroove/smi-core](#readmemd) / [Modules](#modulesmd) / [types](#modulestypesmd) / CcType

# Enumeration: CcType

[types](#modulestypesmd).CcType

Defines a credit card type

## Table of contents

### Enumeration members

- [AMERICAN\_EXPRESS](#american_express)
- [DINERS](#diners)
- [DISCOVER](#discover)
- [JCB](#jcb)
- [MASTERCARD](#mastercard)
- [VISA](#visa)

## Enumeration members

### AMERICAN\_EXPRESS

• **AMERICAN\_EXPRESS** = `3`

#### Defined in

[packages/smi-core/src/types/index.ts:47](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L47)

___

### DINERS

• **DINERS** = `5`

#### Defined in

[packages/smi-core/src/types/index.ts:49](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L49)

___

### DISCOVER

• **DISCOVER** = `4`

#### Defined in

[packages/smi-core/src/types/index.ts:48](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L48)

___

### JCB

• **JCB** = `6`

#### Defined in

[packages/smi-core/src/types/index.ts:50](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L50)

___

### MASTERCARD

• **MASTERCARD** = `2`

#### Defined in

[packages/smi-core/src/types/index.ts:46](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L46)

___

### VISA

• **VISA** = `1`

#### Defined in

[packages/smi-core/src/types/index.ts:45](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L45)


<a name="enumstypeseveryperiodmd"></a>

[@ordergroove/smi-core](#readmemd) / [Modules](#modulesmd) / [types](#modulestypesmd) / EveryPeriod

# Enumeration: EveryPeriod

[types](#modulestypesmd).EveryPeriod

Defines a period of time

## Table of contents

### Enumeration members

- [DAYS](#days)
- [MONTHS](#months)
- [WEEKS](#weeks)

## Enumeration members

### DAYS

• **DAYS** = `1`

#### Defined in

[packages/smi-core/src/types/index.ts:37](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L37)

___

### MONTHS

• **MONTHS** = `3`

#### Defined in

[packages/smi-core/src/types/index.ts:39](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L39)

___

### WEEKS

• **WEEKS** = `2`

#### Defined in

[packages/smi-core/src/types/index.ts:38](https://github.com/ordergroove/plush-toys/blob/5f265228/packages/smi-core/src/types/index.ts#L38)


<a name="enumstypesformnamechoicemd"></a>

[@ordergroove/smi-core](#readmemd) / [Modules](#modulesmd) / [types](#modulestypesmd) / FormNameChoice

# Enumeration: FormNameChoice

[types](#modulestypesmd).FormNameChoice

## Table of contents

### Enumeration members

- [cancel\_subscription](#cancel_subscription)
- [change\_item\_quantity](#change_item_quantity)
- [change\_product](#change_product)
- [change\_quantity](#change_quantity)
- [change\_shipment\_date](#change_shipment_date)
- [change\_shipping\_address](#change_shipping_address)
- [change\_subscription\_frequency](#change_subscription_frequency)
- [delete\_item](#delete_item)
- [pause\_subscription](#pause_subscription)
- [reactivate\_subscription](#reactivate_subscription)
- [send\_now](#send_now)
- [skip\_shipment](#skip_shipment)

## Enumeration members

### cancel\_subscription

• **cancel\_subscription** = `"cancel_subscription"`

Handles the subscription cancellation flow.
This handler will throw an error if no input name="subscription" is available in the context.

<form action={{'cancel_subscription' | action}}>
  <input type="hidden" name="subscription" value="{{ subscription.public_id }}">
  <input type="submit"/> 
 </form>

input subscription public_id of the subscription attempting to cancel

input cancel_reason A valid cancel_reason code CancelReason

Enumeration: OrderSortBy

types.OrderSortBy

Enumeration members

place

Enumeration members

place

• place = "place"

Defined in

packages/smi-core/src/types/index.ts:860

@ordergroove/smi-core / Modules / types / OrderStatus

Enumeration: OrderStatus

types.OrderStatus

This field is used to determine the current status of the order. List of possible order status which are important to note

Enumeration members

CANCELLED
CONNECTION_ERROR_DURING_PLACEMENT
CREDIT_CARD_RETRY
EXCEPTION_DURING_PLACEMENT_PREPARATION
EXPIRED
GENERIC_ERROR_RESPONSE
MERGED
ONE_TIME
PENDING_BATCH_RESPONSE
PENDING_PLACEMENT
PENDING_VERIFICATION
REJECTED
RESPONSE_PROCESSING_ERROR
SEND_NOW
SENT
SUCCESS
UNKNOWN_PLACEMENT_RESPONSE
UNSENT

• GENERIC_ERROR_RESPONSE = 15

A generic error was sent or defaulted by our system. Merchant sets number of times to retry.

Defined in

packages/smi-core/src/types/index.ts:96

MERGED

• MERGED = 17

• UNSENT = 1

Order will be placing some time in the future.

Defined in

packages/smi-core/src/types/index.ts:66

@ordergroove/smi-core / Modules / types / OrderType

Enumeration: OrderType

types.OrderType

Defines the order type

Enumeration members

@ordergroove/smi-core / Modules / types / PaymentMethod

Enumeration: PaymentMethod

types.PaymentMethod

Defines a payment method type

Enumeration members

CREDIT_CARD
PAY_PAL

Enumeration members

CREDIT_CARD

• CREDIT_CARD = 1

Defined in

packages/smi-core/src/types/index.ts:56

PAY_PAL

• PAY_PAL = 2

Defined in

packages/smi-core/src/types/index.ts:57

@ordergroove/smi-core / Modules / types / Action

Interface: Action

types.Action

Properties

payload
type

Properties

payload

• payload: any

Defined in

packages/smi-core/src/types/index.ts:845

type

• type: string

Defined in

packages/smi-core/src/types/index.ts:844

@ordergroove/smi-core / Modules / types / Address

Interface: Address

types.Address

Properties

address
address2
city
company_name
country_code
created
customer
fax
first_name
last_name
live
phone
public_id
state_province_code
store_public_id
zip_postal_code

packages/smi-core/src/types/index.ts:446

@ordergroove/smi-core / Modules / types / Customer

Interface: Customer

types.Customer

This object represents the current customer who is logged into your site that is viewing the SMI

Properties

authorized
public_id
sig
sig_field
ts

packages/smi-core/src/types/index.ts:132

@ordergroove/smi-core / Modules / types / DateFormatString

Interface: DateFormatString

types.DateFormatString

Format	Output	Description
YY	18	Two-digit year
YYYY	2018	Four-digit year
M	1-12	The month, beginning at 1
MM	01-12	The month, 2-digits
MMM	Jan-Dec	The abbreviated month name
MMMM	January-December	The full month name
D	1-31	The day of the month
DD	01-31	The day of the month, 2-digits
d	0-6	The day of the week, with Sunday as 0
dd	Su-Sa	The min name of the day of the week
ddd	Sun-Sat	The short name of the day of the week
dddd	Sunday-Saturday	The name of the day of the week
H	0-23	The hour
HH	00-23	The hour, 2-digits
h	1-12	The hour, 12-hour clock
hh	01-12	The hour, 12-hour clock, 2-digits
m	0-59 \ The minute
mm	00-59	The minute, 2-digits
s	0-59	The second
ss	00-59	The second, 2-digits
SSS	000-999	The millisecond, 3-digits
Z	+05:00	The offset from UTC, ±HH:mm
ZZ	+0500	The offset from UTC, ±HHmm
A	AM PM
a	am pm

export

interface DateFormatString

Hierarchy

String

↳ DateFormatString

Properties

length

Methods

[iterator]
anchor
big
blink
bold
charAt
charCodeAt
codePointAt
concat
endsWith
fixed
fontcolor
fontsize
includes
indexOf
italics
lastIndexOf
link
localeCompare
match
matchAll
normalize
padEnd
padStart
repeat
replace
search
slice
small
split
startsWith
strike
sub
substr
substring
sup
toLocaleLowerCase
toLocaleUpperCase
toLowerCase
toString
toUpperCase
trim
trimEnd
trimLeft
trimRight
trimStart
valueOf

Properties

length

• Readonly length: number

Returns the length of a String object.

Inherited from

String.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:501

Methods

[iterator]

▸ [iterator](): IterableIterator<string>

Iterator

Returns

IterableIterator<string>

Inherited from

String.__@iterator@79

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:247

anchor

▸ anchor(name): string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Name	Type
`name`	`string`

string

Inherited from

String.fixed

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:472

fontcolor

▸ fontcolor(color): string

Returns a  HTML element and sets the color attribute value

Parameters

Name	Type
`color`	`string`

Returns

string

Inherited from

String.fontcolor

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:475

includes

▸ includes(searchString, position?): boolean

Returns true if searchString appears as a substring of the result of converting this
object to a String, at one or more positions that are
greater than or equal to position; otherwise, returns false.

Parameters

Name	Type	Description
`searchString`	`string`	search string
`position?`	`number`	If position is undefined, 0 is assumed, so as to search all of the String.

Returns

boolean

Inherited from

String.includes

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:417

indexOf

▸ indexOf(searchString, position?): number

Returns the position of the first occurrence of a substring.

Parameters

Name	Type	Description
`searchString`	`string`	The substring to search for in the string
`position?`	`number`	The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

Returns

number

Inherited from

String.indexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:421

italics

▸ italics(): string

Name	Type	Description
`that`	`string`	String to compare to target string

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:434

▸ localeCompare(that, locales?, options?): number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string
`locales?`	`string` \| `string`[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
`options?`	`CollatorOptions`	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:4403

match

▸ match(regexp): RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es5.d.ts:440

▸ match(matcher): RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array
containing the results of that search, or null if no matches are found.

Parameters

Name	Type	Description
`matcher`	`Object`	An object that supports being matched against.
`matcher.[match]`	(`string`: `string`) => `RegExpMatchArray`	-

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:239

matchAll

▸ matchAll(regexp): IterableIterator<RegExpMatchArray>

Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

IterableIterator<RegExpMatchArray>

Inherited from

String.matchAll

Defined in

node_modules/typescript/lib/lib.es2020.string.d.ts:29

normalize

▸ normalize(form): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form`	`"NFC"` \| `"NFD"` \| `"NFKC"` \| `"NFKD"`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:432

▸ normalize(form?): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form?`	`string`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:440

padEnd

▸ padEnd(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the end (right) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padEnd

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:46

padStart

▸ padStart(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the start (left) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padStart

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:33

repeat

▸ repeat(count): string

Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.

Parameters

Name	Type	Description
`count`	`number`	number of copies to append

Returns

string

Inherited from

String.repeat

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:447

replace

▸ replace(searchValue, replaceValue): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replaceValue`	`string`	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:447

▸ replace(searchValue, replacer): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:454

▸ replace(searchValue, replaceValue): string

Replaces first match with string or all matches with RegExp.

Parameters

Name	Type	Description
`searchValue`	`Object`	A string or RegExp search value.
`searchValue.[replace]`	(`string`: `string`, `replaceValue`: `string`) => `string`	-
`replaceValue`	`string`	A string containing the text to replace for match.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:246

▸ replace(searchValue, replacer): string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Name	Type	Description
`searchValue`	`Object`	A object can search for and replace matches within a string.
`searchValue.[replace]`	(`string`: `string`, `replacer`: (`substring`: `string`, ...`args`: `any`[]) => `string`) => `string`	-
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:253

search

▸ search(regexp): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	The regular expression pattern and applicable flags.

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es5.d.ts:460

▸ search(searcher): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`searcher`	`Object`	An object which supports searching within a string.
`searcher.[search]`	(`string`: `string`) => `number`	-

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:259

slice

▸ slice(start?, end?): string

Returns a section of a string.

Parameters

Name	Type	Description
`start?`	`number`	The index to the beginning of the specified portion of stringObj.
`end?`	`number`	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Split a string into substrings using the specified separator and return them as an array.

Parameters

Name	Type	Description
`splitter`	`Object`	An object that can split a string.
`splitter.[split]`	(`string`: `string`, `limit?`: `number`) => `string`[]	-
`limit?`	`number`	A value used to limit the number of elements returned in the array.

Returns

string[]

Inherited from

String.split

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:266

startsWith

▸ startsWith(searchString, position?): boolean

Returns true if the sequence of elements of searchString converted to a String is the
same as the corresponding elements of this object (converted to a String) starting at
position. Otherwise returns false.

Parameters

Name	Type
`searchString`	`string`
`position?`	`number`

Parameters

Name	Type	Description
`from`	`number`	The starting position of the desired substring. The index of the first character in the string is zero.
`length?`	`number`	The number of characters to include in the returned substring.

Returns

string

Inherited from

String.substr

Defined in

node_modules/typescript/lib/lib.es5.d.ts:509

substring

▸ substring(start, end?): string

Returns the substring at the specified location within a String object.

Parameters

Name	Type	Description
`start`	`number`	The zero-based index number indicating the beginning of the substring.
`end?`	`number`	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

Inherited from

String.substring

Defined in

node_modules/typescript/lib/lib.es5.d.ts:483

sup

▸ sup(): string

Returns

string

Inherited from

String.trimEnd

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:23

▸ trimEnd(): string

Returns a copy with trailing whitespace removed.

Returns

string

Inherited from

String.trimEnd

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:159

trimLeft

▸ trimLeft(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimLeft

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:29

▸ trimLeft(): string

Removes whitespace from the left end of a string.

Returns

string

Inherited from

String.trimLeft

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:152

trimRight

▸ trimRight(): string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimRight

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:32

▸ trimRight(): string

Removes whitespace from the right end of a string.

Returns

string

Inherited from

String.trimRight

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:154

trimStart

▸ trimStart(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimStart

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:26

▸ trimStart(): string

Returns a copy with leading whitespace removed.

Returns

string

Inherited from

String.trimStart

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:157

valueOf

▸ valueOf(): string

Returns the primitive value of the specified object.

Returns

string

Inherited from

String.valueOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:512

@ordergroove/smi-core / Modules / types / Environment

Interface: Environment

types.Environment

This object represents the environment that the application is currently running in.
You typically will not need to interact with this object unless you're instructed
to by an Ordergroove representative.

Properties

api_url
lego_api
name

Properties

api_url

• api_url: string

URL of the legacy Ordergroove API cluster that the SMI is using to retrieve data.

defaults https://api.ordergroove.com

Defined in

packages/smi-core/src/types/index.ts:651

lego_api

• lego_api: string

URL of the Ordergroove REST API cluster that the SMI is using to retrieve data.

default https://restapi.ordergroove.com

Defined in

packages/smi-core/src/types/index.ts:646

name

• name: EnvironmentChoices

The name of the Ordergroove environment where the SMI is currently running.

Defined in

packages/smi-core/src/types/index.ts:640

@ordergroove/smi-core / Modules / types / MerchantId

Interface: MerchantId

types.MerchantId

This value is used to identify the merchant.

Hierarchy

uuid

↳ MerchantId

Properties

length

Methods

[iterator]
anchor
big
blink
bold
charAt
charCodeAt
codePointAt
concat
endsWith
fixed
fontcolor
fontsize
includes
indexOf
italics
lastIndexOf
link
localeCompare
match
matchAll
normalize
padEnd
padStart
repeat
replace
search
slice
small
split
startsWith
strike
sub
substr
substring
sup
toLocaleLowerCase
toLocaleUpperCase
toLowerCase
toString
toUpperCase
trim
trimEnd
trimLeft
trimRight
trimStart
valueOf

Properties

length

• Readonly length: number

Returns the length of a String object.

Inherited from

uuid.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:501

Methods

[iterator]

▸ [iterator](): IterableIterator<string>

Iterator

Returns

IterableIterator<string>

Inherited from

uuid.[iterator]

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:247

anchor

▸ anchor(name): string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Name	Type
`name`	`string`

Parameters

Name	Type	Description
`pos`	`number`	The zero-based index of the desired character.

Returns

string

Inherited from

uuid.charAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:402

charCodeAt

▸ charCodeAt(index): number

Returns the Unicode value of the character at the specified location.

Parameters

Name	Type	Description
`index`	`number`	The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns

number

Inherited from

uuid.charCodeAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:408

codePointAt

▸ codePointAt(pos): number

Parameters

Name	Type
`pos`	`number`

Returns

number

Inherited from

uuid.codePointAt

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:408

concat

▸ concat(...strings): string

Returns a string that contains the concatenation of two or more strings.

Parameters

Name	Type	Description
`...strings`	`string`[]	The strings to append to the end of the string.

Returns

string

Inherited from

uuid.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:414

endsWith

▸ endsWith(searchString, endPosition?): boolean

Parameters

Name	Type
`searchString`	`string`
`endPosition?`	`number`

Returns

boolean

Inherited from

uuid.endsWith

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:424

fixed

▸ fixed(): string

string

Inherited from

uuid.italics

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:484

lastIndexOf

▸ lastIndexOf(searchString, position?): number

Returns the last occurrence of a substring in the string.

Parameters

Name	Type	Description
`searchString`	`string`	The substring to search for.
`position?`	`number`	The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns

number

Inherited from

uuid.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:428

link

▸ link(url): string

Returns an <a> HTML element and sets the href attribute value

Parameters

Name	Type
`url`	`string`

Returns

string

Inherited from

uuid.link

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:487

localeCompare

▸ localeCompare(that): number

Determines whether two strings are equivalent in the current locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string

Returns

number

Inherited from

uuid.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:434

▸ localeCompare(that, locales?, options?): number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string
`locales?`	`string` \| `string`[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
`options?`	`CollatorOptions`	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Inherited from

uuid.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:4403

match

▸ match(regexp): RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpMatchArray

Inherited from

uuid.match

Defined in

node_modules/typescript/lib/lib.es5.d.ts:440

▸ match(matcher): RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array
containing the results of that search, or null if no matches are found.

Parameters

Name	Type	Description
`matcher`	`Object`	An object that supports being matched against.
`matcher.[match]`	(`string`: `string`) => `RegExpMatchArray`	-

Returns

RegExpMatchArray

Inherited from

uuid.match

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:239

matchAll

▸ matchAll(regexp): IterableIterator<RegExpMatchArray>

Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

IterableIterator<RegExpMatchArray>

Inherited from

uuid.matchAll

Defined in

node_modules/typescript/lib/lib.es2020.string.d.ts:29

normalize

▸ normalize(form): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form`	`"NFC"` \| `"NFD"` \| `"NFKC"` \| `"NFKD"`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

uuid.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:432

▸ normalize(form?): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form?`	`string`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

uuid.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:440

padEnd

▸ padEnd(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the end (right) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

uuid.padEnd

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:46

padStart

▸ padStart(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the start (left) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

uuid.padStart

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:33

repeat

▸ repeat(count): string

Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.

Parameters

Name	Type	Description
`count`	`number`	number of copies to append

Returns

string

Inherited from

uuid.repeat

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:447

replace

▸ replace(searchValue, replaceValue): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replaceValue`	`string`	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Inherited from

uuid.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:447

▸ replace(searchValue, replacer): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

uuid.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:454

▸ replace(searchValue, replaceValue): string

Replaces first match with string or all matches with RegExp.

Parameters

Name	Type	Description
`searchValue`	`Object`	A string or RegExp search value.
`searchValue.[replace]`	(`string`: `string`, `replaceValue`: `string`) => `string`	-
`replaceValue`	`string`	A string containing the text to replace for match.

Returns

string

Inherited from

uuid.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:246

▸ replace(searchValue, replacer): string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Name	Type	Description
`searchValue`	`Object`	A object can search for and replace matches within a string.
`searchValue.[replace]`	(`string`: `string`, `replacer`: (`substring`: `string`, ...`args`: `any`[]) => `string`) => `string`	-
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

uuid.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:253

search

▸ search(regexp): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	The regular expression pattern and applicable flags.

Returns

number

Inherited from

uuid.search

Defined in

node_modules/typescript/lib/lib.es5.d.ts:460

▸ search(searcher): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`searcher`	`Object`	An object which supports searching within a string.
`searcher.[search]`	(`string`: `string`) => `number`	-

Returns

number

Inherited from

uuid.search

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:259

slice

▸ slice(start?, end?): string

Returns a section of a string.

Parameters

Name	Type	Description
`start?`	`number`	The index to the beginning of the specified portion of stringObj.
`end?`	`number`	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Split a string into substrings using the specified separator and return them as an array.

Parameters

Name	Type	Description
`splitter`	`Object`	An object that can split a string.
`splitter.[split]`	(`string`: `string`, `limit?`: `number`) => `string`[]	-
`limit?`	`number`	A value used to limit the number of elements returned in the array.

Returns

string[]

Inherited from

uuid.split

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:266

startsWith

▸ startsWith(searchString, position?): boolean

Parameters

Name	Type
`searchString`	`string`
`position?`	`number`

Parameters

Name	Type	Description
`from`	`number`	The starting position of the desired substring. The index of the first character in the string is zero.
`length?`	`number`	The number of characters to include in the returned substring.

Returns

string

Inherited from

uuid.substr

Defined in

node_modules/typescript/lib/lib.es5.d.ts:509

substring

▸ substring(start, end?): string

Returns the substring at the specified location within a String object.

Parameters

Name	Type	Description
`start`	`number`	The zero-based index number indicating the beginning of the substring.
`end?`	`number`	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

Inherited from

uuid.substring

Defined in

node_modules/typescript/lib/lib.es5.d.ts:483

sup

▸ sup(): string

Returns

string

Inherited from

uuid.trimEnd

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:23

▸ trimEnd(): string

Returns a copy with trailing whitespace removed.

Returns

string

Inherited from

uuid.trimEnd

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:159

trimLeft

▸ trimLeft(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

uuid.trimLeft

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:29

▸ trimLeft(): string

Removes whitespace from the left end of a string.

Returns

string

Inherited from

uuid.trimLeft

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:152

trimRight

▸ trimRight(): string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Inherited from

uuid.trimRight

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:32

▸ trimRight(): string

Removes whitespace from the right end of a string.

Returns

string

Inherited from

uuid.trimRight

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:154

trimStart

▸ trimStart(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

uuid.trimStart

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:26

▸ trimStart(): string

Returns a copy with leading whitespace removed.

Returns

string

Inherited from

uuid.trimStart

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:157

valueOf

▸ valueOf(): string

Returns the primitive value of the specified object.

Returns

string

Inherited from

uuid.valueOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:512

@ordergroove/smi-core / Modules / types / Notification

Interface: Notification

types.Notification

Properties

message
target
time

Properties

message

A string describing the result of a completed action

Defined in

packages/smi-core/src/types/index.ts:594

target

• Optional target: Order | OrderItem | Subscription

The domain object upon which the action was applied

Defined in

packages/smi-core/src/types/index.ts:624

time

• time: number

The timestamp of the notification in milliseconds Date.now()

Defined in

packages/smi-core/src/types/index.ts:589

@ordergroove/smi-core / Modules / types / Order

Interface: Order

types.Order

Represents a customer orders.

Properties

cancelled
created
customer
discount_total
extra_data
generic_error_count
locked
merchant
oos_free_shipping
order_merchant_id
payment
place
public_id
rejected_message
shipping_address
shipping_total
status
sub_total
tax_total
total
tries
type

packages/smi-core/src/types/index.ts:155

oos_free_shipping

• oos_free_shipping: boolean

Interface: OrderItem

types.OrderItem

This object represents an order items which make up the customer's current set of orders.
In order to help visualize this,
we have provided a sample json object in addition to the description of each item object key representation below:

{
  order: 'order123abc',
  offer: null,
  subscription: 'sub123abc',
  product: 'prod123abc',
  components: [],
  quantity: 1,
  public_id: 'item123abc',
  product_attribute: null,
  extra_cost: '0',
  one_time: false,
  frozen: true,
  first_placed: '..',
  price: '0.00',
  total_price: '0.00',
  show_original_price: false
 }

Properties

components
first_placed
frozen
offer
one_time
order
price
product
public_id
quantity
show_original_price
subscription
total_price

Properties

components

• components: String[]

• one_time: boolean

• quantity: number

Interface: Payment

types.Payment

Properties

billing_address
cc_exp_date
cc_holder
cc_number_ending
cc_type
created
customer
label
last_updated
live
payment_method
public_id
token_id

packages/smi-core/src/types/index.ts:371

@ordergroove/smi-core / Modules / types / Product

Interface: Product

types.Product

Each product in the object above contains the following keys

Properties

autoship_by_default
autoship_enabled
created
detail_url
dicontinued
external_product_id
extra_data
groups
image_url
incentive_group
last_update
live
merchant
name
price
product_type
sku

packages/smi-core/src/types/index.ts:788

sku

• sku: String

The sku id of the product.

Defined in

packages/smi-core/src/types/index.ts:747

@ordergroove/smi-core / Modules / types / ProductExtraData

Interface: ProductExtraData

types.ProductExtraData

Type that described the localized properties of a product

{
   i18n_display: {
     'fr-CA': {
       name: 'telephone de cell',
       image_url: 'https://m.media-amazon.com/images/I/51o-rBDk5IL._SR500,500_.jpg',
       detail_url: 'http://www.walmart.ca/fr/ip/vfi-de-sport-de-rame/6000163069962'
     }
   }
 }

Indexable

▪ [key: string]: any

This object accepts an arbitrary key-value pairs

Properties

i18n_display

Properties

i18n_display

• i18n_display: Object

Index signature

▪ [key: string]: { detail_url: string ; image_url: string ; name: string }

Locale name as a key

Defined in

packages/smi-core/src/types/index.ts:680

@ordergroove/smi-core / Modules / types / ProductGroup

Interface: ProductGroup

types.ProductGroup

Properties

group_type
name

Properties

group_type

• group_type: String

This will tell ordergroove treat this group as special like sku swap or eligibility

Defined in

packages/smi-core/src/types/index.ts:657

name

• name: String

Human readable group name

Defined in

packages/smi-core/src/types/index.ts:661

@ordergroove/smi-core / Modules / types / ProductId

Interface: ProductId

types.ProductId

String representaion of product ID

example prod123abc

Hierarchy

String

↳ ProductId

Properties

length

Methods

[iterator]
anchor
big
blink
bold
charAt
charCodeAt
codePointAt
concat
endsWith
fixed
fontcolor
fontsize
includes
indexOf
italics
lastIndexOf
link
localeCompare
match
matchAll
normalize
padEnd
padStart
repeat
replace
search
slice
small
split
startsWith
strike
sub
substr
substring
sup
toLocaleLowerCase
toLocaleUpperCase
toLowerCase
toString
toUpperCase
trim
trimEnd
trimLeft
trimRight
trimStart
valueOf

Properties

length

• Readonly length: number

Returns the length of a String object.

Inherited from

String.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:501

Methods

[iterator]

▸ [iterator](): IterableIterator<string>

Iterator

Returns

IterableIterator<string>

Inherited from

String.__@iterator@79

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:247

anchor

▸ anchor(name): string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Name	Type
`name`	`string`

Parameters

Name	Type	Description
`pos`	`number`	The zero-based index of the desired character.

Returns

string

Inherited from

String.charAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:402

charCodeAt

▸ charCodeAt(index): number

Returns the Unicode value of the character at the specified location.

Parameters

Name	Type	Description
`index`	`number`	The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns

number

Inherited from

String.charCodeAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:408

codePointAt

▸ codePointAt(pos): number

Parameters

Name	Type
`pos`	`number`

Returns

number

Inherited from

String.codePointAt

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:408

concat

▸ concat(...strings): string

Returns a string that contains the concatenation of two or more strings.

Parameters

Name	Type	Description
`...strings`	`string`[]	The strings to append to the end of the string.

Returns

string

Inherited from

String.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:414

endsWith

▸ endsWith(searchString, endPosition?): boolean

Parameters

Name	Type
`searchString`	`string`
`endPosition?`	`number`

Returns

boolean

Inherited from

String.endsWith

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:424

fixed

▸ fixed(): string

string

Inherited from

String.italics

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:484

lastIndexOf

▸ lastIndexOf(searchString, position?): number

Returns the last occurrence of a substring in the string.

Parameters

Name	Type	Description
`searchString`	`string`	The substring to search for.
`position?`	`number`	The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns

number

Inherited from

String.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:428

link

▸ link(url): string

Returns an <a> HTML element and sets the href attribute value

Parameters

Name	Type
`url`	`string`

Returns

string

Inherited from

String.link

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:487

localeCompare

▸ localeCompare(that): number

Determines whether two strings are equivalent in the current locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:434

▸ localeCompare(that, locales?, options?): number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string
`locales?`	`string` \| `string`[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
`options?`	`CollatorOptions`	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:4403

match

▸ match(regexp): RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es5.d.ts:440

▸ match(matcher): RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array
containing the results of that search, or null if no matches are found.

Parameters

Name	Type	Description
`matcher`	`Object`	An object that supports being matched against.
`matcher.[match]`	(`string`: `string`) => `RegExpMatchArray`	-

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:239

matchAll

▸ matchAll(regexp): IterableIterator<RegExpMatchArray>

Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

IterableIterator<RegExpMatchArray>

Inherited from

String.matchAll

Defined in

node_modules/typescript/lib/lib.es2020.string.d.ts:29

normalize

▸ normalize(form): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form`	`"NFC"` \| `"NFD"` \| `"NFKC"` \| `"NFKD"`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:432

▸ normalize(form?): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form?`	`string`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:440

padEnd

▸ padEnd(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the end (right) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padEnd

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:46

padStart

▸ padStart(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the start (left) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padStart

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:33

repeat

▸ repeat(count): string

Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.

Parameters

Name	Type	Description
`count`	`number`	number of copies to append

Returns

string

Inherited from

String.repeat

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:447

replace

▸ replace(searchValue, replaceValue): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replaceValue`	`string`	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:447

▸ replace(searchValue, replacer): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:454

▸ replace(searchValue, replaceValue): string

Replaces first match with string or all matches with RegExp.

Parameters

Name	Type	Description
`searchValue`	`Object`	A string or RegExp search value.
`searchValue.[replace]`	(`string`: `string`, `replaceValue`: `string`) => `string`	-
`replaceValue`	`string`	A string containing the text to replace for match.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:246

▸ replace(searchValue, replacer): string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Name	Type	Description
`searchValue`	`Object`	A object can search for and replace matches within a string.
`searchValue.[replace]`	(`string`: `string`, `replacer`: (`substring`: `string`, ...`args`: `any`[]) => `string`) => `string`	-
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:253

search

▸ search(regexp): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	The regular expression pattern and applicable flags.

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es5.d.ts:460

▸ search(searcher): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`searcher`	`Object`	An object which supports searching within a string.
`searcher.[search]`	(`string`: `string`) => `number`	-

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:259

slice

▸ slice(start?, end?): string

Returns a section of a string.

Parameters

Name	Type	Description
`start?`	`number`	The index to the beginning of the specified portion of stringObj.
`end?`	`number`	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Split a string into substrings using the specified separator and return them as an array.

Parameters

Name	Type	Description
`splitter`	`Object`	An object that can split a string.
`splitter.[split]`	(`string`: `string`, `limit?`: `number`) => `string`[]	-
`limit?`	`number`	A value used to limit the number of elements returned in the array.

Returns

string[]

Inherited from

String.split

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:266

startsWith

▸ startsWith(searchString, position?): boolean

Parameters

Name	Type
`searchString`	`string`
`position?`	`number`

Parameters

Name	Type	Description
`from`	`number`	The starting position of the desired substring. The index of the first character in the string is zero.
`length?`	`number`	The number of characters to include in the returned substring.

Returns

string

Inherited from

String.substr

Defined in

node_modules/typescript/lib/lib.es5.d.ts:509

substring

▸ substring(start, end?): string

Returns the substring at the specified location within a String object.

Parameters

Name	Type	Description
`start`	`number`	The zero-based index number indicating the beginning of the substring.
`end?`	`number`	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

Inherited from

String.substring

Defined in

node_modules/typescript/lib/lib.es5.d.ts:483

sup

▸ sup(): string

Returns

string

Inherited from

String.trimEnd

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:23

▸ trimEnd(): string

Returns a copy with trailing whitespace removed.

Returns

string

Inherited from

String.trimEnd

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:159

trimLeft

▸ trimLeft(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimLeft

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:29

▸ trimLeft(): string

Removes whitespace from the left end of a string.

Returns

string

Inherited from

String.trimLeft

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:152

trimRight

▸ trimRight(): string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimRight

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:32

▸ trimRight(): string

Removes whitespace from the right end of a string.

Returns

string

Inherited from

String.trimRight

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:154

trimStart

▸ trimStart(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimStart

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:26

▸ trimStart(): string

Returns a copy with leading whitespace removed.

Returns

string

Inherited from

String.trimStart

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:157

valueOf

▸ valueOf(): string

Returns the primitive value of the specified object.

Returns

string

Inherited from

String.valueOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:512

@ordergroove/smi-core / Modules / types / SmiState

Interface: SmiState

types.SmiState

Properties

addresses
auth_url
customer
environment
global_error
loading
locale
merchant_id
notifications
order_items
orders
payments
products
subscriptions

Properties

addresses

• addresses: Address[]

Defined in

packages/smi-core/src/types/index.ts:832

auth_url

• auth_url: string

Defined in

packages/smi-core/src/types/index.ts:821

customer

This value is used to identify you as the merchant and is the same value
that you would find under the customer.public_id key above.

Interface: SmiStore

types.SmiStore

Methods

dispatch
getState
subscribe

Methods

dispatch

▸ dispatch(action): undefined

Parameters

Name	Type
`action`	`Action`

Returns

undefined

Defined in

packages/smi-core/src/types/index.ts:853

getState

▸ getState(): SmiState

Returns

SmiState

Defined in

packages/smi-core/src/types/index.ts:852

▸ subscribe(listener): undefined

Parameters

Name	Type
`listener`	`CallableFunction`

Returns

undefined

Defined in

packages/smi-core/src/types/index.ts:851

@ordergroove/smi-core / Modules / types / Subscription

Interface: Subscription

types.Subscription

Object that represents a subscription and contains the following fields:

Properties

cancel_reason
cancel_reason_code
cancelled
components
created
customer
every
every_period
extra_data
frequency_days
live
merchant
merchant_order_id
payment
price
product
public_id
quantity
raw_subscription_type
reminder_days
session_id
shipping_address
start_date
updated

packages/smi-core/src/types/index.ts:523

raw_subscription_type

• raw_subscription_type: String

Interface: date

types.date

String representation of date in ordergroove.

example 2021-04-04

Hierarchy

String

↳ date

Properties

length

Methods

[iterator]
anchor
big
blink
bold
charAt
charCodeAt
codePointAt
concat
endsWith
fixed
fontcolor
fontsize
includes
indexOf
italics
lastIndexOf
link
localeCompare
match
matchAll
normalize
padEnd
padStart
repeat
replace
search
slice
small
split
startsWith
strike
sub
substr
substring
sup
toLocaleLowerCase
toLocaleUpperCase
toLowerCase
toString
toUpperCase
trim
trimEnd
trimLeft
trimRight
trimStart
valueOf

Properties

length

• Readonly length: number

Returns the length of a String object.

Inherited from

String.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:501

Methods

[iterator]

▸ [iterator](): IterableIterator<string>

Iterator

Returns

IterableIterator<string>

Inherited from

String.__@iterator@79

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:247

anchor

▸ anchor(name): string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Name	Type
`name`	`string`

Parameters

Name	Type	Description
`pos`	`number`	The zero-based index of the desired character.

Returns

string

Inherited from

String.charAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:402

charCodeAt

▸ charCodeAt(index): number

Returns the Unicode value of the character at the specified location.

Parameters

Name	Type	Description
`index`	`number`	The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns

number

Inherited from

String.charCodeAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:408

codePointAt

▸ codePointAt(pos): number

Parameters

Name	Type
`pos`	`number`

Returns

number

Inherited from

String.codePointAt

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:408

concat

▸ concat(...strings): string

Returns a string that contains the concatenation of two or more strings.

Parameters

Name	Type	Description
`...strings`	`string`[]	The strings to append to the end of the string.

Returns

string

Inherited from

String.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:414

endsWith

▸ endsWith(searchString, endPosition?): boolean

Parameters

Name	Type
`searchString`	`string`
`endPosition?`	`number`

Returns

boolean

Inherited from

String.endsWith

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:424

fixed

▸ fixed(): string

string

Inherited from

String.italics

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:484

lastIndexOf

▸ lastIndexOf(searchString, position?): number

Returns the last occurrence of a substring in the string.

Parameters

Name	Type	Description
`searchString`	`string`	The substring to search for.
`position?`	`number`	The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns

number

Inherited from

String.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:428

link

▸ link(url): string

Returns an <a> HTML element and sets the href attribute value

Parameters

Name	Type
`url`	`string`

Returns

string

Inherited from

String.link

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:487

localeCompare

▸ localeCompare(that): number

Determines whether two strings are equivalent in the current locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:434

▸ localeCompare(that, locales?, options?): number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string
`locales?`	`string` \| `string`[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
`options?`	`CollatorOptions`	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:4403

match

▸ match(regexp): RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es5.d.ts:440

▸ match(matcher): RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array
containing the results of that search, or null if no matches are found.

Parameters

Name	Type	Description
`matcher`	`Object`	An object that supports being matched against.
`matcher.[match]`	(`string`: `string`) => `RegExpMatchArray`	-

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:239

matchAll

▸ matchAll(regexp): IterableIterator<RegExpMatchArray>

Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

IterableIterator<RegExpMatchArray>

Inherited from

String.matchAll

Defined in

node_modules/typescript/lib/lib.es2020.string.d.ts:29

normalize

▸ normalize(form): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form`	`"NFC"` \| `"NFD"` \| `"NFKC"` \| `"NFKD"`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:432

▸ normalize(form?): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form?`	`string`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:440

padEnd

▸ padEnd(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the end (right) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padEnd

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:46

padStart

▸ padStart(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the start (left) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padStart

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:33

repeat

▸ repeat(count): string

Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.

Parameters

Name	Type	Description
`count`	`number`	number of copies to append

Returns

string

Inherited from

String.repeat

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:447

replace

▸ replace(searchValue, replaceValue): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replaceValue`	`string`	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:447

▸ replace(searchValue, replacer): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:454

▸ replace(searchValue, replaceValue): string

Replaces first match with string or all matches with RegExp.

Parameters

Name	Type	Description
`searchValue`	`Object`	A string or RegExp search value.
`searchValue.[replace]`	(`string`: `string`, `replaceValue`: `string`) => `string`	-
`replaceValue`	`string`	A string containing the text to replace for match.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:246

▸ replace(searchValue, replacer): string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Name	Type	Description
`searchValue`	`Object`	A object can search for and replace matches within a string.
`searchValue.[replace]`	(`string`: `string`, `replacer`: (`substring`: `string`, ...`args`: `any`[]) => `string`) => `string`	-
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:253

search

▸ search(regexp): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	The regular expression pattern and applicable flags.

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es5.d.ts:460

▸ search(searcher): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`searcher`	`Object`	An object which supports searching within a string.
`searcher.[search]`	(`string`: `string`) => `number`	-

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:259

slice

▸ slice(start?, end?): string

Returns a section of a string.

Parameters

Name	Type	Description
`start?`	`number`	The index to the beginning of the specified portion of stringObj.
`end?`	`number`	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Split a string into substrings using the specified separator and return them as an array.

Parameters

Name	Type	Description
`splitter`	`Object`	An object that can split a string.
`splitter.[split]`	(`string`: `string`, `limit?`: `number`) => `string`[]	-
`limit?`	`number`	A value used to limit the number of elements returned in the array.

Returns

string[]

Inherited from

String.split

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:266

startsWith

▸ startsWith(searchString, position?): boolean

Parameters

Name	Type
`searchString`	`string`
`position?`	`number`

Parameters

Name	Type	Description
`from`	`number`	The starting position of the desired substring. The index of the first character in the string is zero.
`length?`	`number`	The number of characters to include in the returned substring.

Returns

string

Inherited from

String.substr

Defined in

node_modules/typescript/lib/lib.es5.d.ts:509

substring

▸ substring(start, end?): string

Returns the substring at the specified location within a String object.

Parameters

Name	Type	Description
`start`	`number`	The zero-based index number indicating the beginning of the substring.
`end?`	`number`	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

Inherited from

String.substring

Defined in

node_modules/typescript/lib/lib.es5.d.ts:483

sup

▸ sup(): string

Returns

string

Inherited from

String.trimEnd

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:23

▸ trimEnd(): string

Returns a copy with trailing whitespace removed.

Returns

string

Inherited from

String.trimEnd

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:159

trimLeft

▸ trimLeft(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimLeft

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:29

▸ trimLeft(): string

Removes whitespace from the left end of a string.

Returns

string

Inherited from

String.trimLeft

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:152

trimRight

▸ trimRight(): string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimRight

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:32

▸ trimRight(): string

Removes whitespace from the right end of a string.

Returns

string

Inherited from

String.trimRight

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:154

trimStart

▸ trimStart(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimStart

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:26

▸ trimStart(): string

Returns a copy with leading whitespace removed.

Returns

string

Inherited from

String.trimStart

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:157

valueOf

▸ valueOf(): string

Returns the primitive value of the specified object.

Returns

string

Inherited from

String.valueOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:512

@ordergroove/smi-core / Modules / types / datetime

Interface: datetime

types.datetime

String representation of date and time in ordergroove.

example 2021-04-04 09:19:52

Hierarchy

String

↳ datetime

Properties

length

Methods

[iterator]
anchor
big
blink
bold
charAt
charCodeAt
codePointAt
concat
endsWith
fixed
fontcolor
fontsize
includes
indexOf
italics
lastIndexOf
link
localeCompare
match
matchAll
normalize
padEnd
padStart
repeat
replace
search
slice
small
split
startsWith
strike
sub
substr
substring
sup
toLocaleLowerCase
toLocaleUpperCase
toLowerCase
toString
toUpperCase
trim
trimEnd
trimLeft
trimRight
trimStart
valueOf

Properties

length

• Readonly length: number

Returns the length of a String object.

Inherited from

String.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:501

Methods

[iterator]

▸ [iterator](): IterableIterator<string>

Iterator

Returns

IterableIterator<string>

Inherited from

String.__@iterator@79

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:247

anchor

▸ anchor(name): string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Name	Type
`name`	`string`

Parameters

Name	Type	Description
`pos`	`number`	The zero-based index of the desired character.

Returns

string

Inherited from

String.charAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:402

charCodeAt

▸ charCodeAt(index): number

Returns the Unicode value of the character at the specified location.

Parameters

Name	Type	Description
`index`	`number`	The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns

number

Inherited from

String.charCodeAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:408

codePointAt

▸ codePointAt(pos): number

Parameters

Name	Type
`pos`	`number`

Returns

number

Inherited from

String.codePointAt

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:408

concat

▸ concat(...strings): string

Returns a string that contains the concatenation of two or more strings.

Parameters

Name	Type	Description
`...strings`	`string`[]	The strings to append to the end of the string.

Returns

string

Inherited from

String.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:414

endsWith

▸ endsWith(searchString, endPosition?): boolean

Parameters

Name	Type
`searchString`	`string`
`endPosition?`	`number`

Returns

boolean

Inherited from

String.endsWith

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:424

fixed

▸ fixed(): string

string

Inherited from

String.italics

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:484

lastIndexOf

▸ lastIndexOf(searchString, position?): number

Returns the last occurrence of a substring in the string.

Parameters

Name	Type	Description
`searchString`	`string`	The substring to search for.
`position?`	`number`	The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns

number

Inherited from

String.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:428

link

▸ link(url): string

Returns an <a> HTML element and sets the href attribute value

Parameters

Name	Type
`url`	`string`

Returns

string

Inherited from

String.link

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:487

localeCompare

▸ localeCompare(that): number

Determines whether two strings are equivalent in the current locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:434

▸ localeCompare(that, locales?, options?): number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string
`locales?`	`string` \| `string`[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
`options?`	`CollatorOptions`	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:4403

match

▸ match(regexp): RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es5.d.ts:440

▸ match(matcher): RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array
containing the results of that search, or null if no matches are found.

Parameters

Name	Type	Description
`matcher`	`Object`	An object that supports being matched against.
`matcher.[match]`	(`string`: `string`) => `RegExpMatchArray`	-

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:239

matchAll

▸ matchAll(regexp): IterableIterator<RegExpMatchArray>

Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

IterableIterator<RegExpMatchArray>

Inherited from

String.matchAll

Defined in

node_modules/typescript/lib/lib.es2020.string.d.ts:29

normalize

▸ normalize(form): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form`	`"NFC"` \| `"NFD"` \| `"NFKC"` \| `"NFKD"`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:432

▸ normalize(form?): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form?`	`string`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:440

padEnd

▸ padEnd(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the end (right) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padEnd

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:46

padStart

▸ padStart(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the start (left) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padStart

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:33

repeat

▸ repeat(count): string

Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.

Parameters

Name	Type	Description
`count`	`number`	number of copies to append

Returns

string

Inherited from

String.repeat

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:447

replace

▸ replace(searchValue, replaceValue): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replaceValue`	`string`	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:447

▸ replace(searchValue, replacer): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:454

▸ replace(searchValue, replaceValue): string

Replaces first match with string or all matches with RegExp.

Parameters

Name	Type	Description
`searchValue`	`Object`	A string or RegExp search value.
`searchValue.[replace]`	(`string`: `string`, `replaceValue`: `string`) => `string`	-
`replaceValue`	`string`	A string containing the text to replace for match.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:246

▸ replace(searchValue, replacer): string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Name	Type	Description
`searchValue`	`Object`	A object can search for and replace matches within a string.
`searchValue.[replace]`	(`string`: `string`, `replacer`: (`substring`: `string`, ...`args`: `any`[]) => `string`) => `string`	-
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:253

search

▸ search(regexp): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	The regular expression pattern and applicable flags.

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es5.d.ts:460

▸ search(searcher): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`searcher`	`Object`	An object which supports searching within a string.
`searcher.[search]`	(`string`: `string`) => `number`	-

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:259

slice

▸ slice(start?, end?): string

Returns a section of a string.

Parameters

Name	Type	Description
`start?`	`number`	The index to the beginning of the specified portion of stringObj.
`end?`	`number`	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Split a string into substrings using the specified separator and return them as an array.

Parameters

Name	Type	Description
`splitter`	`Object`	An object that can split a string.
`splitter.[split]`	(`string`: `string`, `limit?`: `number`) => `string`[]	-
`limit?`	`number`	A value used to limit the number of elements returned in the array.

Returns

string[]

Inherited from

String.split

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:266

startsWith

▸ startsWith(searchString, position?): boolean

Parameters

Name	Type
`searchString`	`string`
`position?`	`number`

Parameters

Name	Type	Description
`from`	`number`	The starting position of the desired substring. The index of the first character in the string is zero.
`length?`	`number`	The number of characters to include in the returned substring.

Returns

string

Inherited from

String.substr

Defined in

node_modules/typescript/lib/lib.es5.d.ts:509

substring

▸ substring(start, end?): string

Returns the substring at the specified location within a String object.

Parameters

Name	Type	Description
`start`	`number`	The zero-based index number indicating the beginning of the substring.
`end?`	`number`	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

Inherited from

String.substring

Defined in

node_modules/typescript/lib/lib.es5.d.ts:483

sup

▸ sup(): string

Returns

string

Inherited from

String.trimEnd

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:23

▸ trimEnd(): string

Returns a copy with trailing whitespace removed.

Returns

string

Inherited from

String.trimEnd

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:159

trimLeft

▸ trimLeft(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimLeft

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:29

▸ trimLeft(): string

Removes whitespace from the left end of a string.

Returns

string

Inherited from

String.trimLeft

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:152

trimRight

▸ trimRight(): string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimRight

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:32

▸ trimRight(): string

Removes whitespace from the right end of a string.

Returns

string

Inherited from

String.trimRight

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:154

trimStart

▸ trimStart(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimStart

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:26

▸ trimStart(): string

Returns a copy with leading whitespace removed.

Returns

string

Inherited from

String.trimStart

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:157

valueOf

▸ valueOf(): string

Returns the primitive value of the specified object.

Returns

string

Inherited from

String.valueOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:512

@ordergroove/smi-core / Modules / types / uuid

Interface: uuid

types.uuid

It consists of 32 alphanumeric character hash

example d4ce4ebe635211e8bf29bc764e1107f2

Hierarchy

String

↳ uuid

↳↳ MerchantId

Properties

length

Methods

[iterator]
anchor
big
blink
bold
charAt
charCodeAt
codePointAt
concat
endsWith
fixed
fontcolor
fontsize
includes
indexOf
italics
lastIndexOf
link
localeCompare
match
matchAll
normalize
padEnd
padStart
repeat
replace
search
slice
small
split
startsWith
strike
sub
substr
substring
sup
toLocaleLowerCase
toLocaleUpperCase
toLowerCase
toString
toUpperCase
trim
trimEnd
trimLeft
trimRight
trimStart
valueOf

Properties

length

• Readonly length: number

Returns the length of a String object.

Inherited from

String.length

Defined in

node_modules/typescript/lib/lib.es5.d.ts:501

Methods

[iterator]

▸ [iterator](): IterableIterator<string>

Iterator

Returns

IterableIterator<string>

Inherited from

String.__@iterator@79

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:247

anchor

▸ anchor(name): string

Returns an <a> HTML anchor element and sets the name attribute to the text value

Parameters

Name	Type
`name`	`string`

Parameters

Name	Type	Description
`pos`	`number`	The zero-based index of the desired character.

Returns

string

Inherited from

String.charAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:402

charCodeAt

▸ charCodeAt(index): number

Returns the Unicode value of the character at the specified location.

Parameters

Name	Type	Description
`index`	`number`	The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns

number

Inherited from

String.charCodeAt

Defined in

node_modules/typescript/lib/lib.es5.d.ts:408

codePointAt

▸ codePointAt(pos): number

Parameters

Name	Type
`pos`	`number`

Returns

number

Inherited from

String.codePointAt

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:408

concat

▸ concat(...strings): string

Returns a string that contains the concatenation of two or more strings.

Parameters

Name	Type	Description
`...strings`	`string`[]	The strings to append to the end of the string.

Returns

string

Inherited from

String.concat

Defined in

node_modules/typescript/lib/lib.es5.d.ts:414

endsWith

▸ endsWith(searchString, endPosition?): boolean

Parameters

Name	Type
`searchString`	`string`
`endPosition?`	`number`

Returns

boolean

Inherited from

String.endsWith

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:424

fixed

▸ fixed(): string

string

Inherited from

String.italics

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:484

lastIndexOf

▸ lastIndexOf(searchString, position?): number

Returns the last occurrence of a substring in the string.

Parameters

Name	Type	Description
`searchString`	`string`	The substring to search for.
`position?`	`number`	The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns

number

Inherited from

String.lastIndexOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:428

link

▸ link(url): string

Returns an <a> HTML element and sets the href attribute value

Parameters

Name	Type
`url`	`string`

Returns

string

Inherited from

String.link

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:487

localeCompare

▸ localeCompare(that): number

Determines whether two strings are equivalent in the current locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:434

▸ localeCompare(that, locales?, options?): number

Determines whether two strings are equivalent in the current or specified locale.

Parameters

Name	Type	Description
`that`	`string`	String to compare to target string
`locales?`	`string` \| `string`[]	A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
`options?`	`CollatorOptions`	An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

Returns

number

Inherited from

String.localeCompare

Defined in

node_modules/typescript/lib/lib.es5.d.ts:4403

match

▸ match(regexp): RegExpMatchArray

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es5.d.ts:440

▸ match(matcher): RegExpMatchArray

Matches a string or an object that supports being matched against, and returns an array
containing the results of that search, or null if no matches are found.

Parameters

Name	Type	Description
`matcher`	`Object`	An object that supports being matched against.
`matcher.[match]`	(`string`: `string`) => `RegExpMatchArray`	-

Returns

RegExpMatchArray

Inherited from

String.match

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:239

matchAll

▸ matchAll(regexp): IterableIterator<RegExpMatchArray>

Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.

Parameters

Name	Type	Description
`regexp`	`RegExp`	A variable name or string literal containing the regular expression pattern and flags.

Returns

IterableIterator<RegExpMatchArray>

Inherited from

String.matchAll

Defined in

node_modules/typescript/lib/lib.es2020.string.d.ts:29

normalize

▸ normalize(form): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form`	`"NFC"` \| `"NFD"` \| `"NFKC"` \| `"NFKD"`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:432

▸ normalize(form?): string

Returns the String value result of normalizing the string into the normalization form
named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters

Name	Type	Description
`form?`	`string`	Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns

string

Inherited from

String.normalize

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:440

padEnd

▸ padEnd(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the end (right) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padEnd

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:46

padStart

▸ padStart(maxLength, fillString?): string

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
The padding is applied from the start (left) of the current string.

Parameters

Name	Type	Description
`maxLength`	`number`	The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
`fillString?`	`string`	The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns

string

Inherited from

String.padStart

Defined in

node_modules/typescript/lib/lib.es2017.string.d.ts:33

repeat

▸ repeat(count): string

Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.

Parameters

Name	Type	Description
`count`	`number`	number of copies to append

Returns

string

Inherited from

String.repeat

Defined in

node_modules/typescript/lib/lib.es2015.core.d.ts:447

replace

▸ replace(searchValue, replaceValue): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replaceValue`	`string`	A string containing the text to replace for every successful match of searchValue in this string.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:447

▸ replace(searchValue, replacer): string

Replaces text in a string, using a regular expression or search string.

Parameters

Name	Type	Description
`searchValue`	`string` \| `RegExp`	A string to search for.
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es5.d.ts:454

▸ replace(searchValue, replaceValue): string

Replaces first match with string or all matches with RegExp.

Parameters

Name	Type	Description
`searchValue`	`Object`	A string or RegExp search value.
`searchValue.[replace]`	(`string`: `string`, `replaceValue`: `string`) => `string`	-
`replaceValue`	`string`	A string containing the text to replace for match.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:246

▸ replace(searchValue, replacer): string

Replaces text in a string, using an object that supports replacement within a string.

Parameters

Name	Type	Description
`searchValue`	`Object`	A object can search for and replace matches within a string.
`searchValue.[replace]`	(`string`: `string`, `replacer`: (`substring`: `string`, ...`args`: `any`[]) => `string`) => `string`	-
`replacer`	(`substring`: `string`, ...`args`: `any`[]) => `string`	A function that returns the replacement text.

Returns

string

Inherited from

String.replace

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:253

search

▸ search(regexp): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`regexp`	`string` \| `RegExp`	The regular expression pattern and applicable flags.

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es5.d.ts:460

▸ search(searcher): number

Finds the first substring match in a regular expression search.

Parameters

Name	Type	Description
`searcher`	`Object`	An object which supports searching within a string.
`searcher.[search]`	(`string`: `string`) => `number`	-

Returns

number

Inherited from

String.search

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:259

slice

▸ slice(start?, end?): string

Returns a section of a string.

Parameters

Name	Type	Description
`start?`	`number`	The index to the beginning of the specified portion of stringObj.
`end?`	`number`	The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Split a string into substrings using the specified separator and return them as an array.

Parameters

Name	Type	Description
`splitter`	`Object`	An object that can split a string.
`splitter.[split]`	(`string`: `string`, `limit?`: `number`) => `string`[]	-
`limit?`	`number`	A value used to limit the number of elements returned in the array.

Returns

string[]

Inherited from

String.split

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:266

startsWith

▸ startsWith(searchString, position?): boolean

Parameters

Name	Type
`searchString`	`string`
`position?`	`number`

Parameters

Name	Type	Description
`from`	`number`	The starting position of the desired substring. The index of the first character in the string is zero.
`length?`	`number`	The number of characters to include in the returned substring.

Returns

string

Inherited from

String.substr

Defined in

node_modules/typescript/lib/lib.es5.d.ts:509

substring

▸ substring(start, end?): string

Returns the substring at the specified location within a String object.

Parameters

Name	Type	Description
`start`	`number`	The zero-based index number indicating the beginning of the substring.
`end?`	`number`	Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns

string

Inherited from

String.substring

Defined in

node_modules/typescript/lib/lib.es5.d.ts:483

sup

▸ sup(): string

Returns

string

Inherited from

String.trimEnd

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:23

▸ trimEnd(): string

Returns a copy with trailing whitespace removed.

Returns

string

Inherited from

String.trimEnd

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:159

trimLeft

▸ trimLeft(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimLeft

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:29

▸ trimLeft(): string

Removes whitespace from the left end of a string.

Returns

string

Inherited from

String.trimLeft

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:152

trimRight

▸ trimRight(): string

Removes the trailing white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimRight

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:32

▸ trimRight(): string

Removes whitespace from the right end of a string.

Returns

string

Inherited from

String.trimRight

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:154

trimStart

▸ trimStart(): string

Removes the leading white space and line terminator characters from a string.

Returns

string

Inherited from

String.trimStart

Defined in

node_modules/typescript/lib/lib.es2019.string.d.ts:26

▸ trimStart(): string

Returns a copy with leading whitespace removed.

Returns

string

Inherited from

String.trimStart

Defined in

packages/smi-core/node_modules/@types/node/globals.d.ts:157

valueOf

▸ valueOf(): string

Returns the primitive value of the specified object.

Returns

string

Inherited from

String.valueOf

Defined in

node_modules/typescript/lib/lib.es5.d.ts:512

@ordergroove/smi-core / Modules

@ordergroove/smi-core

Modules

smi-core
smi-core/filters
types

@ordergroove/smi-core / Modules / smi-core / api

Namespace: api

smi-core.api

Functions

request_orders
request_orders_items
request_product
request_subscriptions

Functions

request_orders

▸ request_orders(options): Promise<Object>

Performs an asynchronous request to fetch orders and update the state with the result

const {results: ordersInRetryStatus} = await og.smi.api.request_orders({ status: 18 });

Parameters

Name	Type	Description
`options`	`Object`	Describing filter and ordering.
`options.ordering?`	`place`	-
`options.status?`	`OrderStatus`[]	-

Returns

Promise<Object>

Defined in

packages/smi-core/src/api.js:16

request_orders_items

▸ request_orders_items(options): Promise<Object>

Performs an asynchronous request to fetch order items and update the state with the result

const {results: orderItemsInRetryStatus} = await og.smi.api.request_orders_items({ status: 18 });

Parameters

Name	Type	Description
`options`	`Object`	Describes order status filter
`options.status?`	`OrderStatus`[]	-

Returns

Promise<Object>

Defined in

packages/smi-core/src/api.js:29

request_product

▸ request_product(external_product_id): Promise<Product>

Performs an asynchronous request to a product and update the state with the result

Parameters

Name	Type	Description
`external_product_id`	`string`	Product identifier (external_product_id)

Returns

Promise<Product>

Defined in

packages/smi-core/src/api.js:47

request_subscriptions

▸ request_subscriptions(options): Promise<Object>

Performs an asynchronous request to fetch subscriptions and update the state with the result

Parameters

Name	Type
`options`	`any`

Returns

Promise<Object>

Defined in

packages/smi-core/src/api.js:37

@ordergroove/smi-core / Modules / smi-core / dayjs

Namespace: dayjs

smi-core.dayjs

Classes

Dayjs

Type aliases

ConfigType
OpUnitType
OptionType
PluginFunc
QUnitType
UnitType
UnitTypeLong
UnitTypeLongPlural
UnitTypeShort

Variables

Functions

extend
isDayjs
locale
unix

Type aliases

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:22

Name	Type
`T`	`unknown`

Parameters

Name	Type
`plugin`	`PluginFunc`<`T`>
`option?`	`T`

Returns

Dayjs

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:412

isDayjs

▸ isDayjs(d): d is Dayjs

Parameters

Name	Type
`d`	`any`

Returns

d is Dayjs

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:416

locale

▸ locale(preset?, object?, isLocal?): string

Parameters

Name	Type
`preset?`	`string` \| `ILocale`
`object?`	`Partial`<`ILocale`>
`isLocal?`	`boolean`

Returns

string

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:414

unix

▸ unix(t): Dayjs

Parameters

Name	Type
`t`	`number`

Returns

Dayjs

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:418

@ordergroove/smi-core / Modules / smi-core

Module: smi-core

Main smi-core module.

Main exports:

Smi
bootstrap
api
memoize
[[html]]
dayjs

References

default

Namespaces

api
dayjs

Classes

Properties

memoize

Functions

bootstrap
dayjs
html

References

default

Renames and re-exports bootstrap

Properties

memoize

• memoize: any

Functions

bootstrap

▸ bootstrap(runtimeConfig, templateGenerator): void

Function that bootstrap smi for a given merchants

NOTE: auth and auth_url are boot optionals, if none is present smi will attempt
find og_auth cookie

Parameters

Name	Type
`runtimeConfig`	`any`
`templateGenerator`	`any`

Returns

void

Defined in

packages/smi-core/src/bootstrap.js:50

dayjs

▸ dayjs(date?): Dayjs

Parameters

Name	Type
`date?`	`ConfigType`

Returns

Dayjs

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:5

▸ dayjs(date?, format?, strict?): Dayjs

Parameters

Name	Type
`date?`	`ConfigType`
`format?`	`OptionType`
`strict?`	`boolean`

Returns

Dayjs

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:7

▸ dayjs(date?, format?, locale?, strict?): Dayjs

Parameters

Name	Type
`date?`	`ConfigType`
`format?`	`OptionType`
`locale?`	`string`
`strict?`	`boolean`

Returns

Dayjs

Defined in

packages/smi-core/node_modules/dayjs/index.d.ts:9

html

▸ Const html(strings, ...values): TemplateResult

Interprets a template literal as an HTML template that can efficiently
render to and update a container.

Parameters

Name	Type
`strings`	`TemplateStringsArray`
`...values`	`unknown`[]

Returns

TemplateResult

Defined in

packages/smi-core/node_modules/lit-html/lit-html.d.ts:36

@ordergroove/smi-core / Modules / smi-core/filters

Module: smi-core/filters

Filters

Filters provide a way for you to apply a function over a variable before it's rendered to the page. In order to use a filter you will have to call it following a variable declaration and separated by a |. Most common use-case for this is the need to modify or format the variable content before it's included in the template. For example, let's say that you wanted to display a ISO date in a more human readable format:

In the example above, we are using the date filter and it will render to the customer as:

Standard date: {{ order.place }}
 Formatted date: {{ order.place | date }}

In the example above, we are using the date filter and it will render to the customer as:

Standard date: 2020-05-10
Formatted date: May 10, 2020

### Filter with parameters

Since filters are just a way for you to apply a function over a variable, some filters also
support the idea of additional parameters. You can supply additional parameters by passing
them into the filter, the same way as you would in other programming paradigms. A good example
of this is the date filter from our earlier example. It accepts a date format as a parameter
that allows you to have greater flexibility over how the date is displayed. Please find a few
examples below:

Localized format 1: {{ order.place | date('L') }}
Localized format 2: {{ order.place | date('LL') }}
Non-localized specific format: {{ order.place | date('MMM D YYYY') }}

In the example above, we're displaying a date in two different localized formats and a
non-localized one. You can see the resulting message below if the current locale was set to English.

Localized format: 01/10/2020
Localized format: January 10, 2020
Non-localized specific format: Jan 10 2020

You can read more about our list of supported filters in the Filter Reference

List of available filters:

action
currency
date
dump
entries
find
first
get
if_defined
last
reject
select
shuffle
sort
until

Properties

default

Functions

createFilters

Properties

default

• default: any

Functions

createFilters

▸ createFilters(locale): TemplateFilters

Parameters

Name	Type
`locale`	`any`

Returns

TemplateFilters

Defined in

packages/smi-core/src/core/filters/create-filters.js:83

@ordergroove/smi-core / Modules / types

Module: types

Action Payloads Enumerations

OrderSortBy

Other Enumerations

CancelReason
CcType
EveryPeriod
FormNameChoice
OrderStatus
OrderType
PaymentMethod

Application Interface Interfaces

Action
SmiState
SmiStore

Domain Models Interfaces

Customer
Environment
Notification
Order
OrderItem
Product
Subscription

Domain Models

Object that represents a payment and contains the following fields: Interfaces

Payment

Domain Models

Object that represents an address and contains the following fields: Interfaces

Address

Generic types Interfaces

ProductId
date
datetime
uuid

Other Interfaces

DateFormatString
MerchantId
ProductExtraData
ProductGroup

Type aliases

ActionFilter
BootstrapOptions
CurrencyFilter
DateFilter
DumpFilter
EntriesFilter
EnvironmentChoices
FindFilter
FirstFilter
GetFilter
IfDefinedFilter
LastFilter
RejectFilter
SelectFilter
ShuffleFilter
SortFilter
TemplateFilters
TemplateGenerator
UntilFilter

Type aliases

ActionFilter

Ƭ ActionFilter: (formName: FormNameChoice) => (part: any) => void

Type declaration

▸ (formName): (part: any) => void

This filter handles the form validation and submission to ordergrooves backend

<form action="{{ 'send_now' | action }}">
 <input type="hidden" value="{{ subscription.public_id }}" name="subscription" />
 <button class="og-button" type="submit" name="send_now">Send</button>
</form>

Parameters

Name	Type	Description
`formName`	`FormNameChoice`	Special keyword describing how the form needs to be handled. Note that some handlers require special field sin the form to be present as hidden inputs. See FormNameChoice

Returns

fn

▸ (part): void

Parameters

Name	Type
`part`	`any`

Returns

void

Defined in

packages/smi-core/src/types/index.ts:933

BootstrapOptions

Ƭ BootstrapOptions: Object

Type declaration

Name	Type
`auth?`	`Object`
`auth_url?`	`String`
`env`	`EnvironmentChoices`
`merchant_id`	`MerchantId`

Defined in

packages/smi-core/src/types/index.ts:862

CurrencyFilter

Ƭ CurrencyFilter: (amount: string | number, currency?: string, currencyDisplay?: string) => string

Type declaration

▸ (amount, currency?, currencyDisplay?): string

Returns a localized currency number. Internally using NumberFormat

Parameters

Name	Type	Description
`amount`	`string` \| `number`	Number or string like number
`currency?`	`string`	A valid currency code it defaults whatever localization file says as "currency_code": "USD",
`currencyDisplay?`	`string`	How to display the curency defaults to narrow

Returns

string

Defined in

packages/smi-core/src/types/index.ts:997

DateFilter

Ƭ DateFilter: (value: string | date | datetime, format: DateFormatString) => string

Type declaration

▸ (value, format): string

Returns a localized date in specified format

Parameters

Name	Type	Description
`value`	`string` \| `date` \| `datetime`	Value any string like date value
`format`	`DateFormatString`	String may be any combination of DateFormatString

Returns

string

Defined in

packages/smi-core/src/types/index.ts:941

DumpFilter

Ƭ DumpFilter: (value: any) => string

Type declaration

▸ (value): string

Dumps the string represantation of the value, useful for debugging purpose.

Parameters

Name	Type
`value`	`any`

Returns

string

Defined in

packages/smi-core/src/types/index.ts:1071

EntriesFilter

Ƭ EntriesFilter: (value: any) => string

Type declaration

▸ (value): string

Returns the result of JavaScript's Object.entries function

Parameters

Name	Type
`value`	`any`

Returns

https://lit-html.polymer-project.org/guide/template-reference#ifdefined

Parameters

Name	Type
`value`	`unknown`

Returns

fn

▸ (part): void

Parameters

Name	Type
`part`	`Part`

Returns

void

Defined in

packages/smi-core/src/types/index.ts:989

LastFilter

Ƭ LastFilter: (list: any, ...identity: any[]) => any

Type declaration

▸ (list, ...identity): any

https://lodash.com/docs/4.17.15#last

Parameters

Name	Type
`list`	`any`
`...identity`	`any`[]

Returns

any

Defined in

packages/smi-core/src/types/index.ts:1066

RejectFilter

Ƭ RejectFilter: (list: any, ...identity: any[]) => any

Type declaration

▸ (list, ...identity): any

https://lodash.com/docs/4.17.15#reject

Parameters

Name	Type
`list`	`any`
`...identity`	`any`[]

Returns

any

Defined in

packages/smi-core/src/types/index.ts:1024

SelectFilter

Ƭ SelectFilter: (list: any, ...identity: any[]) => any

Type declaration

▸ (list, ...identity): any

Creates an identity function based on an optional filter function.
If no filter function is provided and the argiment is a string of 32 length, a default filter function using public_id will be used.

Parameters

Name	Type
`list`	`any`
`...identity`	`any`[]

Returns

any

Defined in

packages/smi-core/src/types/index.ts:1014

ShuffleFilter

Ƭ ShuffleFilter: (list: any) => any

Type declaration

▸ (list): any

Creates an array of shuffled values, using a version of the
Fisher-Yates shuffle.

{% for reason in cancel_reasons | entries | shuffle %}
  {% set code = reason | first %}
  {% set text = reason | last %}
  {% if code != '1' %}
    <div class="og-input-group">
      <input class="og-check-radio" required type="radio" name="cancel_reason" 
        value="{{ code }} | {{ text }}" id="cancel_reason_{{ code }}_{{ subscription.public_id }}"/>
      <label class="og-check-radio-label" for="cancel_reason_{{ code }}_{{ subscription.public_id }}">
        {{ text }}
      </label>
    </div>
  {% endif %}
{% endfor %}

Parameters

Name	Type
`list`	`any`

Returns

any

Defined in

packages/smi-core/src/types/index.ts:1061

SortFilter

Ƭ SortFilter: (list: any, ...identity: any[]) => any

Type declaration

▸ (list, ...identity): any

https://lodash.com/docs/4.17.15#sort

Parameters

Name	Type
`list`	`any`
`...identity`	`any`[]

Returns

any

Defined in

packages/smi-core/src/types/index.ts:1029

TemplateFilters

Ƭ TemplateFilters: Object

Filters are essentially functions that can be applied to variables.
They are called with a pipe operator (|) and can take arguments.

{{ foo | title }}
{{ foo | join(",") }}
{{ foo | replace("foo", "bar") | capitalize }}

The third example shows how you can chain filters. It would display "Bar",
by first replacing "foo" with "bar" and then capitalizing it.

A filter is simply a function that takes the target object as the first argument and any arguments passed to the filter as the other arguments, in order.

Type declaration

Name	Type
`action`	`ActionFilter`
`currency`	`CurrencyFilter`
`date`	`DateFilter`
`dump`	`DumpFilter`
`entries`	`EntriesFilter`
`find`	`FindFilter`
`first`	`FirstFilter`
`get`	`GetFilter`
`if_defined`	`IfDefinedFilter`
`last`	`LastFilter`
`reject`	`RejectFilter`
`select`	`SelectFilter`
`shuffle`	`ShuffleFilter`
`sort`	`SortFilter`
`until`	`UntilFilter`

Defined in

packages/smi-core/src/types/index.ts:1095

TemplateGenerator

Ƭ TemplateGenerator: (html: Function) => (state: SmiState) => TemplateResult

Type declaration

▸ (html): (state: SmiState) => TemplateResult

Parameters

Name	Type
`html`	`Function`

Returns

fn

▸ (state): TemplateResult

Parameters

Name	Type
`state`	`SmiState`

Returns

TemplateResult

Defined in

packages/smi-core/src/types/index.ts:869

UntilFilter

Ƭ UntilFilter: (...args: unknown[]) => (part: Part) => void

Type declaration

▸ (...args): (part: Part) => void

https://lit-html.polymer-project.org/guide/template-reference#until

Parameters

Name	Type
`...args`	`unknown`[]

Returns

fn

▸ (part): void

Parameters

Name	Type
`part`	`Part`

Returns

void

Defined in

packages/smi-core/src/types/index.ts:984