Header menu logo fable-electron-docs-api

Cookies Type

⚠ Process Availability: Main ✔ | Renderer ❌ | Utility ❌ | Exported ❌

Instance members

Instance member Description

this.flushStore ()

Full Usage: this.flushStore ()

Returns: Promise<unit>
Modifiers: inline

A promise which resolves when the cookie store has been flushedWrites any unwritten cookies data to diskCookies written by any method will not be written to disk immediately, but will be written every 30 seconds or 512 operationsCalling this method can cause the cookie to be written to disk immediately.

Returns: Promise<unit>

this.get (?url, ?name, ?domain, ?path, ?secure, ?session, ?httpOnly)

Full Usage: this.get (?url, ?name, ?domain, ?path, ?secure, ?session, ?httpOnly)

Parameters:
    ?url : string
    ?name : string
    ?domain : string
    ?path : string
    ?secure : bool
    ?session : bool
    ?httpOnly : bool

Returns: Promise<Cookie[]>
Modifiers: inline

A promise which resolves an array of cookie objects.Sends a request to get all cookies matching filter, and resolves a promise with the response.

?url : string
?name : string
?domain : string
?path : string
?secure : bool
?session : bool
?httpOnly : bool
Returns: Promise<Cookie[]>

this.offChanged handler

Full Usage: this.offChanged handler

Parameters:
Modifiers: inline

Emitted when a cookie is changed because it was added, edited, removed, or expired.

handler : IOnChanged -> unit

this.offChanged handler

Full Usage: this.offChanged handler

Parameters:
Modifiers: inline

Emitted when a cookie is changed because it was added, edited, removed, or expired.

handler : Event -> Cookie -> Cause -> bool -> unit

this.onChanged handler

Full Usage: this.onChanged handler

Parameters:
Modifiers: inline

Emitted when a cookie is changed because it was added, edited, removed, or expired.

handler : IOnChanged -> unit

this.onChanged handler

Full Usage: this.onChanged handler

Parameters:
Modifiers: inline

Emitted when a cookie is changed because it was added, edited, removed, or expired.

handler : Event -> Cookie -> Cause -> bool -> unit

this.onceChanged handler

Full Usage: this.onceChanged handler

Parameters:
Modifiers: inline

Emitted when a cookie is changed because it was added, edited, removed, or expired.

handler : IOnChanged -> unit

this.onceChanged handler

Full Usage: this.onceChanged handler

Parameters:
Modifiers: inline

Emitted when a cookie is changed because it was added, edited, removed, or expired.

handler : Event -> Cookie -> Cause -> bool -> unit

this.remove (url, name)

Full Usage: this.remove (url, name)

Parameters:
    url : string
    name : string

Returns: Promise<unit>
Modifiers: inline

A promise which resolves when the cookie has been removedRemoves the cookies matching url and name

url : string
name : string
Returns: Promise<unit>

this.set (url, ?name, ?value, ?domain, ?path, ?secure, ?httpOnly, ?expirationDate, ?sameSite)

Full Usage: this.set (url, ?name, ?value, ?domain, ?path, ?secure, ?httpOnly, ?expirationDate, ?sameSite)

Parameters:
    url : string
    ?name : string
    ?value : string
    ?domain : string
    ?path : string
    ?secure : bool
    ?httpOnly : bool
    ?expirationDate : double
    ?sameSite : SameSite

Returns: Promise<unit>
Modifiers: inline

A promise which resolves when the cookie has been setSets a cookie with details.

url : string
?name : string
?value : string
?domain : string
?path : string
?secure : bool
?httpOnly : bool
?expirationDate : double
?sameSite : SameSite
Returns: Promise<unit>

Type something to start searching.