Skip to content

[V2-2191] better names for get and set cookies functions #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
santios-volusion wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[V2-2191] better names for get and set cookies functions #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 4 additions & 15 deletions utils-dataprops/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,30 @@

This document describes the `API` of the `utils` parameter.


## `utils.get(name: string): string`
## `utils.getCookie(name: string): string`

Function to get the value of a cookie with the provided `name`


## `utils.set(name: string, value: string): void`
## `utils.setCookie(name: string, value: string): void`

Function to create a cookie with `name` and `value`


## `utils.addAmpScript(name: string): void`

Adds AMP script with the provided `name`. See [block utils docs][utils-block]


## `utils.addScript(url: string): void`

Adds script with `url` to the head of the document. See [block utils docs][utils-block]


## `utils.canonicalUrl(query?: Object): string`

Returns a store URL with a query string. See [block utils docs][utils-block]


## `utils.isAmpRequest: boolean`

Returns `true` if the request is AMP. See [block utils docs][utils-block]


## `utils.queryParams(): Object`

Returns an object with the query parameters of the current request.
Expand All @@ -53,21 +46,17 @@ console.log(utils.queryParams());

Return an object with helpful functions for SEO as documented below.

*`utils.seo().setTitle(title: string)`*
_`utils.seo().setTitle(title: string)`_

Sets the title of the page to the provided `title`

*`utils.seo().setDescription(description: string)`*
_`utils.seo().setDescription(description: string)`_

Sets a description to be used in the meta description using the `description` parameter.


## `utils.client`

See the [Volusion API client][volusion-api] documentation.


[utils-block]: ../utils-block
[volusion-api]: ../volusion-api-client