CookieJar | @foxy.io/sdk

Hierarchy

CookieJar
- CookieJar

Index

Constructors

constructor

Methods

Constructors

constructor

new CookieJar(store?: Store, options?: CookieJar.Options): CookieJar

Inherited from CookieJar.constructor
- Defined in node_modules/@types/tough-cookie/index.d.ts:171
Parameters
- Optional store: Store
- Optional options: CookieJar.Options
Returns CookieJar

Methods

clone

clone(store?: Store): Promise<CookieJar>
clone(store: Store, cb: ((err: null | Error, newJar: CookieJar) => void)): void
clone(cb: ((err: null | Error, newJar: CookieJar) => void)): void

Inherited from CookieJar.clone
- Defined in node_modules/@types/tough-cookie/index.d.ts:204
Parameters
- Optional store: Store
Returns Promise<CookieJar>
Inherited from CookieJar.clone
- Defined in node_modules/@types/tough-cookie/index.d.ts:205
Parameters
- store: Store
- cb: ((err: null | Error, newJar: CookieJar) => void)
  - - (err: null | Error, newJar: CookieJar): void
    - Parameters
      - err: null | Error
      - newJar: CookieJar
      Returns void
Returns void
Inherited from CookieJar.clone
- Defined in node_modules/@types/tough-cookie/index.d.ts:206
Parameters
- cb: ((err: null | Error, newJar: CookieJar) => void)
  - - (err: null | Error, newJar: CookieJar): void
    - Parameters
      - err: null | Error
      - newJar: CookieJar
      Returns void
Returns void

cloneSync

cloneSync(store?: Store): CookieJar

Inherited from CookieJar.cloneSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:208
Parameters
- Optional store: Store
Returns CookieJar

getCookieString

getCookieString(currentUrl: string, options?: CookieJar.GetCookiesOptions): Promise<string>
getCookieString(currentUrl: string, options: CookieJar.GetCookiesOptions, cb: ((err: null | Error, cookies: string) => void)): void
getCookieString(currentUrl: string, cb: ((err: null | Error, cookies: string) => void)): void

Inherited from CookieJar.getCookieString
- Defined in node_modules/@types/tough-cookie/index.d.ts:185
Parameters
- currentUrl: string
- Optional options: CookieJar.GetCookiesOptions
Returns Promise<string>
Inherited from CookieJar.getCookieString
- Defined in node_modules/@types/tough-cookie/index.d.ts:186
Parameters
- currentUrl: string
- options: CookieJar.GetCookiesOptions
- cb: ((err: null | Error, cookies: string) => void)
  - - (err: null | Error, cookies: string): void
    - Parameters
      - err: null | Error
      - cookies: string
      Returns void
Returns void
Inherited from CookieJar.getCookieString
- Defined in node_modules/@types/tough-cookie/index.d.ts:187
Parameters
- currentUrl: string
- cb: ((err: null | Error, cookies: string) => void)
  - - (err: null | Error, cookies: string): void
    - Parameters
      - err: null | Error
      - cookies: string
      Returns void
Returns void

getCookieStringSync

getCookieStringSync(currentUrl: string, options?: CookieJar.GetCookiesOptions): string

Inherited from CookieJar.getCookieStringSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:189
Parameters
- currentUrl: string
- Optional options: CookieJar.GetCookiesOptions
Returns string

getCookies

getCookies(currentUrl: string, options?: CookieJar.GetCookiesOptions): Promise<Cookie[]>
getCookies(currentUrl: string, options: CookieJar.GetCookiesOptions, cb: ((err: null | Error, cookies: Cookie[]) => void)): void
getCookies(currentUrl: string, cb: ((err: null | Error, cookies: Cookie[]) => void)): void

Inherited from CookieJar.getCookies
- Defined in node_modules/@types/tough-cookie/index.d.ts:179
Parameters
- currentUrl: string
- Optional options: CookieJar.GetCookiesOptions
Returns Promise<Cookie[]>
Inherited from CookieJar.getCookies
- Defined in node_modules/@types/tough-cookie/index.d.ts:180
Parameters
- currentUrl: string
- options: CookieJar.GetCookiesOptions
- cb: ((err: null | Error, cookies: Cookie[]) => void)
  - - (err: null | Error, cookies: Cookie[]): void
    - Parameters
      - err: null | Error
      - cookies: Cookie[]
      Returns void
Returns void
Inherited from CookieJar.getCookies
- Defined in node_modules/@types/tough-cookie/index.d.ts:181
Parameters
- currentUrl: string
- cb: ((err: null | Error, cookies: Cookie[]) => void)
  - - (err: null | Error, cookies: Cookie[]): void
    - Parameters
      - err: null | Error
      - cookies: Cookie[]
      Returns void
Returns void

getCookiesSync

getCookiesSync(currentUrl: string, options?: CookieJar.GetCookiesOptions): Cookie[]

Inherited from CookieJar.getCookiesSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:183
Parameters
- currentUrl: string
- Optional options: CookieJar.GetCookiesOptions
Returns Cookie[]

getSetCookieStrings

getSetCookieStrings(currentUrl: string, options?: CookieJar.GetCookiesOptions): Promise<string[]>
getSetCookieStrings(currentUrl: string, options: CookieJar.GetCookiesOptions, cb: ((err: null | Error, cookies: string[]) => void)): void
getSetCookieStrings(currentUrl: string, cb: ((err: null | Error, cookies: string[]) => void)): void

Inherited from CookieJar.getSetCookieStrings
- Defined in node_modules/@types/tough-cookie/index.d.ts:191
Parameters
- currentUrl: string
- Optional options: CookieJar.GetCookiesOptions
Returns Promise<string[]>
Inherited from CookieJar.getSetCookieStrings
- Defined in node_modules/@types/tough-cookie/index.d.ts:192
Parameters
- currentUrl: string
- options: CookieJar.GetCookiesOptions
- cb: ((err: null | Error, cookies: string[]) => void)
  - - (err: null | Error, cookies: string[]): void
    - Parameters
      - err: null | Error
      - cookies: string[]
      Returns void
Returns void
Inherited from CookieJar.getSetCookieStrings
- Defined in node_modules/@types/tough-cookie/index.d.ts:193
Parameters
- currentUrl: string
- cb: ((err: null | Error, cookies: string[]) => void)
  - - (err: null | Error, cookies: string[]): void
    - Parameters
      - err: null | Error
      - cookies: string[]
      Returns void
Returns void

getSetCookieStringsSync

getSetCookieStringsSync(currentUrl: string, options?: CookieJar.GetCookiesOptions): string[]

Inherited from CookieJar.getSetCookieStringsSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:195
Parameters
- currentUrl: string
- Optional options: CookieJar.GetCookiesOptions
Returns string[]

removeAllCookies

removeAllCookies(): Promise<void>
removeAllCookies(cb: ((err: null | Error) => void)): void

Inherited from CookieJar.removeAllCookies
- Defined in node_modules/@types/tough-cookie/index.d.ts:210
Returns Promise<void>
Inherited from CookieJar.removeAllCookies
- Defined in node_modules/@types/tough-cookie/index.d.ts:211
Parameters
- cb: ((err: null | Error) => void)
  - - (err: null | Error): void
    - Parameters
      - err: null | Error
      Returns void
Returns void

removeAllCookiesSync

removeAllCookiesSync(): void

Inherited from CookieJar.removeAllCookiesSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:213
Returns void

serialize

serialize(): Promise<CookieJar.Serialized>
serialize(cb: ((err: null | Error, serializedObject: CookieJar.Serialized) => void)): void

Inherited from CookieJar.serialize
- Defined in node_modules/@types/tough-cookie/index.d.ts:197
Returns Promise<CookieJar.Serialized>
Inherited from CookieJar.serialize
- Defined in node_modules/@types/tough-cookie/index.d.ts:198
Parameters
- cb: ((err: null | Error, serializedObject: CookieJar.Serialized) => void)
  - - (err: null | Error, serializedObject: CookieJar.Serialized): void
    - Parameters
      - err: null | Error
      - serializedObject: CookieJar.Serialized
      Returns void
Returns void

serializeSync

serializeSync(): CookieJar.Serialized

Inherited from CookieJar.serializeSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:200
Returns CookieJar.Serialized

setCookie

setCookie(cookieOrString: string | Cookie, currentUrl: string, options?: CookieJar.SetCookieOptions): Promise<Cookie>
setCookie(cookieOrString: string | Cookie, currentUrl: string, options: CookieJar.SetCookieOptions, cb: ((err: null | Error, cookie: Cookie) => void)): void
setCookie(cookieOrString: string | Cookie, currentUrl: string, cb: ((err: null | Error, cookie: Cookie) => void)): void

Inherited from CookieJar.setCookie
- Defined in node_modules/@types/tough-cookie/index.d.ts:173
Parameters
- cookieOrString: string | Cookie
- currentUrl: string
- Optional options: CookieJar.SetCookieOptions
Returns Promise<Cookie>
Inherited from CookieJar.setCookie
- Defined in node_modules/@types/tough-cookie/index.d.ts:174
Parameters
- cookieOrString: string | Cookie
- currentUrl: string
- options: CookieJar.SetCookieOptions
- cb: ((err: null | Error, cookie: Cookie) => void)
  - - (err: null | Error, cookie: Cookie): void
    - Parameters
      - err: null | Error
      - cookie: Cookie
      Returns void
Returns void
Inherited from CookieJar.setCookie
- Defined in node_modules/@types/tough-cookie/index.d.ts:175
Parameters
- cookieOrString: string | Cookie
- currentUrl: string
- cb: ((err: null | Error, cookie: Cookie) => void)
  - - (err: null | Error, cookie: Cookie): void
    - Parameters
      - err: null | Error
      - cookie: Cookie
      Returns void
Returns void

setCookieSync

setCookieSync(cookieOrString: string | Cookie, currentUrl: string, options?: CookieJar.SetCookieOptions): Cookie

Inherited from CookieJar.setCookieSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:177
Parameters
- cookieOrString: string | Cookie
- currentUrl: string
- Optional options: CookieJar.SetCookieOptions
Returns Cookie

toJSON

toJSON(): CookieJar.Serialized

Inherited from CookieJar.toJSON
- Defined in node_modules/@types/tough-cookie/index.d.ts:202
Returns CookieJar.Serialized

Static deserialize

deserialize(serialized: string | CookieJar.Serialized, store?: Store): Promise<CookieJar>
deserialize(serialized: string | CookieJar.Serialized, store: Store, cb: ((err: null | Error, object: CookieJar) => void)): void
deserialize(serialized: string | CookieJar.Serialized, cb: ((err: null | Error, object: CookieJar) => void)): void

Inherited from CookieJar.deserialize
- Defined in node_modules/@types/tough-cookie/index.d.ts:163
Parameters
- serialized: string | CookieJar.Serialized
- Optional store: Store
Returns Promise<CookieJar>
Inherited from CookieJar.deserialize
- Defined in node_modules/@types/tough-cookie/index.d.ts:164
Parameters
- serialized: string | CookieJar.Serialized
- store: Store
- cb: ((err: null | Error, object: CookieJar) => void)
  - - (err: null | Error, object: CookieJar): void
    - Parameters
      - err: null | Error
      - object: CookieJar
      Returns void
Returns void
Inherited from CookieJar.deserialize
- Defined in node_modules/@types/tough-cookie/index.d.ts:165
Parameters
- serialized: string | CookieJar.Serialized
- cb: ((err: null | Error, object: CookieJar) => void)
  - - (err: null | Error, object: CookieJar): void
    - Parameters
      - err: null | Error
      - object: CookieJar
      Returns void
Returns void

Static deserializeSync

deserializeSync(serialized: string | CookieJar.Serialized, store?: Store): CookieJar

Inherited from CookieJar.deserializeSync
- Defined in node_modules/@types/tough-cookie/index.d.ts:167
Parameters
- serialized: string | CookieJar.Serialized
- Optional store: Store
Returns CookieJar

Static fromJSON

fromJSON(string: string): CookieJar

Inherited from CookieJar.fromJSON
- Defined in node_modules/@types/tough-cookie/index.d.ts:169
Parameters
- string: string
Returns CookieJar

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional store: Store

Optional options: CookieJar.Options

Returns CookieJar

Methods

clone

Parameters

Optional store: Store

Returns Promise<CookieJar>

Parameters

store: Store

cb: ((err: null | Error, newJar: CookieJar) => void)

Parameters

err: null | Error

newJar: CookieJar

Returns void

Returns void

Parameters

cb: ((err: null | Error, newJar: CookieJar) => void)

Parameters

err: null | Error

newJar: CookieJar

Returns void

Returns void

cloneSync

Parameters

Optional store: Store

Returns CookieJar

getCookieString

Parameters

currentUrl: string

Optional options: CookieJar.GetCookiesOptions

Returns Promise<string>

Parameters

currentUrl: string

options: CookieJar.GetCookiesOptions

cb: ((err: null | Error, cookies: string) => void)

Parameters

err: null | Error

cookies: string

Returns void

Returns void

Parameters

currentUrl: string

cb: ((err: null | Error, cookies: string) => void)

Parameters

err: null | Error

cookies: string

Returns void

Returns void

getCookieStringSync

Parameters

currentUrl: string

Optional options: CookieJar.GetCookiesOptions

Returns string

getCookies

Parameters

currentUrl: string

Optional options: CookieJar.GetCookiesOptions

Returns Promise<Cookie[]>

Parameters

currentUrl: string

options: CookieJar.GetCookiesOptions

cb: ((err: null | Error, cookies: Cookie[]) => void)

Parameters

err: null | Error

cookies: Cookie[]

Returns void

Returns void

Parameters

currentUrl: string

cb: ((err: null | Error, cookies: Cookie[]) => void)

Parameters

err: null | Error