Class CookieJar

Hierarchy

CookieJar
- CookieJar

Index

Constructors

Methods

clone cloneSync getCookieString getCookieStringSync getCookies getCookiesSync getSetCookieStrings getSetCookieStringsSync removeAllCookies removeAllCookiesSync serialize serializeSync setCookie setCookieSync toJSON deserialize deserializeSync fromJSON

Constructors

constructor

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

Methods

clone

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

cloneSync

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

getCookieString

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

getCookieStringSync

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

getCookies

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

getCookiesSync

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

getSetCookieStrings

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

getSetCookieStringsSync

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

removeAllCookies

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

removeAllCookiesSync

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

serialize

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

serializeSync

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

setCookie

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

setCookieSync

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

toJSON

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

`Static` deserialize

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

`Static` deserializeSync

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

`Static` fromJSON

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

Class 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: Error, newJar: CookieJar) => void)

Parameters

err: Error

newJar: CookieJar

Returns void

Returns void

Parameters

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

Parameters

err: 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: Error, cookies: string) => void)

Parameters

err: Error

cookies: string

Returns void

Returns void

Parameters

currentUrl: string

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

Parameters

err: 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: Error, cookies: Cookie[]) => void)

Parameters

err: Error

cookies: Cookie[]

Returns void

Returns void

Parameters

currentUrl: string

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

Parameters

`Optional` store: Store

`Optional` options: CookieJar.Options

`Optional` store: Store

`Optional` store: Store

`Optional` options: CookieJar.GetCookiesOptions

`Optional` options: CookieJar.GetCookiesOptions

`Optional` options: CookieJar.GetCookiesOptions

`Optional` options: CookieJar.GetCookiesOptions

`Optional` options: CookieJar.GetCookiesOptions

`Optional` options: CookieJar.GetCookiesOptions

`Optional` options: CookieJar.SetCookieOptions