Methods
domain(domain) → {CookieFilter}
Sets the domain for the cookie.
Parameters:
| Name | Type | Description |
|---|---|---|
domain | string | The domain to set. |
- Source
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
expiry(expiry) → {CookieFilter}
Sets the expiry value.
Parameters:
| Name | Type | Description |
|---|---|---|
expiry | number | The expiry value. |
- Source
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
httpOnly(httpOnly) → {CookieFilter}
Sets the httpOnly flag for the cookie filter.
Parameters:
| Name | Type | Description |
|---|---|---|
httpOnly | boolean | The value to set for the |
- Source
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
name(name) → {CookieFilter}
Sets the name of the cookie.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | The name of the cookie. |
- Source
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
path(path) → {CookieFilter}
Sets the url path for the cookie to be fetched.
Parameters:
| Name | Type | Description |
|---|---|---|
path | string | The url path for the cookie to be fetched. |
- Source
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
sameSite(sameSite) → {CookieFilter}
Sets the SameSite attribute for the cookie.
Parameters:
| Name | Type | Description |
|---|---|---|
sameSite | SameSite | The SameSite value to be set for the cookie. |
- Source
Throws:
- If the provided sameSite value is not an instance of SameSite.
- Type
- Error
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
secure(secure) → {CookieFilter}
Sets the flag to fetch secure cookies.
Parameters:
| Name | Type | Description |
|---|---|---|
secure | boolean | Whether the cookie fetched should be secure only or not. |
- Source
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
size(size) → {CookieFilter}
Sets the size of the cookie to be fetched.
Parameters:
| Name | Type | Description |
|---|---|---|
size | number | The size of the cookie. |
- Source
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter
value(value) → {CookieFilter}
Sets the value of the cookie.
Parameters:
| Name | Type | Description |
|---|---|---|
value | BytesValue | The value to be set. Must be an instance of BytesValue. |
- Source
Throws:
- If the value is not an instance of BytesValue.
- Type
- Error
Returns:
- The updated CookieFilter instance for chaining.
- Type:
- CookieFilter