API Docs for: 0.2.7
Show:

Cookie Class

Defined in: lib/cookie.js:8
Module: Storage
Parent Module: WebDriver

Cookie data-structure

Constructor

Methods

getDomain

() String | Undefined

Defined in lib/cookie.js:101

(Optional) The domain the cookie is visible to. Direct-access. No need to wait.

Returns:

String | Undefined:

getExpiry

() Number | Undefined

Defined in lib/cookie.js:176

(Optional) When the cookie expires, specified in seconds since midnight, January 1, 1970 UTC. Direct-access. No need to wait.

Returns:

Number | Undefined:

getName

() String

Defined in lib/cookie.js:27

The name of the cookie. Direct-access. No need to wait.

Returns:

getPath

() String | Undefined

Defined in lib/cookie.js:77

(Optional) The cookie path. Direct-access. No need to wait.

Returns:

String | Undefined:

getValue

() String

Defined in lib/cookie.js:52

The cookie value. Direct-access. No need to wait.

Returns:

isHttpOnly

() Boolean | Undefined

Defined in lib/cookie.js:151

(Optional) Whether the cookie is an httpOnly cookie. Direct-access. No need to wait.

Returns:

Boolean | Undefined:

isSecure

() Boolean | Undefined

Defined in lib/cookie.js:126

(Optional) Whether the cookie is a secure cookie. Direct-access. No need to wait.

Returns:

Boolean | Undefined:

setDomain

(
  • domain
)

Defined in lib/cookie.js:112

Set the domain the cookie is visible to. Direct-access. No need to wait.

Parameters:

setExpiry

(
  • expiry
)

Defined in lib/cookie.js:187

Set when the cookie expires, specified in seconds since midnight, January 1, 1970 UTC. Direct-access. No need to wait.

Parameters:

setHttpOnly

(
  • httpOnly
)

Defined in lib/cookie.js:162

Set whether the cookie is an httpOnly cookie. Direct-access. No need to wait.

Parameters:

setName

(
  • name
)

Defined in lib/cookie.js:38

The name of the cookie. Direct-access. No need to wait.

Parameters:

setPath

(
  • path
)

Defined in lib/cookie.js:88

Set the cookie path. Direct-access. No need to wait.

Parameters:

setSecure

(
  • secure
)

Defined in lib/cookie.js:137

Set whether the cookie is a secure cookie. Direct-access. No need to wait.

Parameters:

setValue

(
  • value
)

Defined in lib/cookie.js:63

The cookie value. Direct-access. No need to wait.

Parameters:

toObject

() Object

Defined in lib/cookie.js:201

Get cookie data-structure Direct-access. No need to wait.

Returns:

validate

(
  • [completed=false]
)

Defined in lib/cookie.js:212

Validate the cookie data

Parameters:

  • [completed=false] Boolean optional