Class SyncCookie<Options, GetOptions, SetOptions, ClearOptions, CopyOptions, HasOptions, RemoveOptions>

The SyncCookie class is an abstraction to implement any synchronous cookie API in an uniform way.

Aracna Reference

Type Parameters

Options extends CookieOptions = CookieOptions
GetOptions = unknown
SetOptions = unknown
ClearOptions = SetOptions
CopyOptions = GetOptions
HasOptions = GetOptions
RemoveOptions = SetOptions

Hierarchy

Cookie<Options>
- SyncCookie

Index

Constructors

constructor

new SyncCookie<
    Options extends CookieOptions = CookieOptions,
    GetOptions = unknown,
    SetOptions = unknown,
    ClearOptions = SetOptions,
    CopyOptions = GetOptions,
    HasOptions = GetOptions,
    RemoveOptions = SetOptions,
>(
    name: string,
    clear: (options?: ClearOptions) => void,
    get: <T extends CookieItem>(key: string, options?: GetOptions) => T,
    has: (key: string, options?: HasOptions) => boolean,
    remove: <T extends CookieItem>(
        key: string,
        keys?: (keyof T)[],
        options?: RemoveOptions,
    ) => void,
    set: <T extends CookieItem>(
        key: string,
        item: T,
        options?: SetOptions,
    ) => void,
): SyncCookie<
    Options,
    GetOptions,
    SetOptions,
    ClearOptions,
    CopyOptions,
    HasOptions,
    RemoveOptions,
>
Type Parameters
- Options extends CookieOptions = CookieOptions
- GetOptions = unknown
- SetOptions = unknown
- ClearOptions = SetOptions
- CopyOptions = GetOptions
- HasOptions = GetOptions
- RemoveOptions = SetOptions
Parameters
- name: string
- clear: (options?: ClearOptions) => void
- get: <T extends CookieItem>(key: string, options?: GetOptions) => T
- has: (key: string, options?: HasOptions) => boolean
- remove: <T extends CookieItem>(
      key: string,
      keys?: (keyof T)[],
      options?: RemoveOptions,
  ) => void
- set: <T extends CookieItem>(key: string, item: T, options?: SetOptions) => void
Returns SyncCookie<
    Options,
    GetOptions,
    SetOptions,
    ClearOptions,
    CopyOptions,
    HasOptions,
    RemoveOptions,
>
Overrides Cookie<Options>.constructor
- Defined in src/classes/sync-cookie.ts:20

Properties

`Protected` `Readonly`_clear

_clear: Clear

`Protected` `Readonly`_get

_get: Get

`Protected` `Readonly`_has

_has: Has

`Protected` `Readonly`_remove

_remove: Remove

`Protected` `Readonly`_set

_set: Set

`Protected` `Readonly`name

name: string

The cookie instance name.

`Protected` `Optional`options

options?: Options

The cookie options.

Methods

clear

clear(options?: ClearOptions): void | Error
Clears all cookies.
Parameters
- Optionaloptions: ClearOptions
Returns void | Error
Overrides Cookie.clear
- Defined in src/classes/sync-cookie.ts:34

`Protected`clear_

clear_(cleared: void | Error): void | Error
Parameters
- cleared: void | Error
Returns void | Error
Inherited from Cookie.clear_
- Defined in src/classes/cookie.ts:51

copy

copy<
    T1 extends CookieItem,
    T2 extends CookieTarget = CookieTarget,
    T extends CookieItem & CookieTarget = T1 & T2,
>(
    key: string,
    target: T2,
    keys?: (keyof T)[],
    options?: CopyOptions,
): void | Error
Copies an item from the cookies to a target object. Optionally you can specify the keys of the item that you want to copy, if you don't specify any key the whole item will be copied.
Type Parameters
- T1 extends CookieItem
- T2 extends CookieTarget = CookieTarget
- T extends CookieItem & CookieTarget = T1 & T2
Parameters
- key: string
- target: T2
- Optionalkeys: (keyof T)[]
- Optionaloptions: CopyOptions
Returns void | Error
Overrides Cookie.copy
- Defined in src/classes/sync-cookie.ts:65

`Protected`copy_

copy_<
    T1 extends CookieItem,
    T2 extends CookieTarget,
    T extends CookieItem & CookieTarget,
>(
    key: string,
    target: T2,
    keys: (keyof T)[] | undefined,
    item: Error | T1,
): void | Error
Type Parameters
- T1 extends CookieItem
- T2 extends CookieTarget
- T extends CookieItem & CookieTarget
Parameters
- key: string
- target: T2
- keys: (keyof T)[] | undefined
- item: Error | T1
Returns void | Error
Inherited from Cookie.copy_
- Defined in src/classes/cookie.ts:112

get

get<T extends CookieItem>(key: string, options?: GetOptions): Error | T
Retrieves an item from the cookies.
Type Parameters
- T extends CookieItem
Parameters
- key: string
- Optionaloptions: GetOptions
Returns Error | T
Overrides Cookie.get
- Defined in src/classes/sync-cookie.ts:41

`Protected`get_

get_<T extends CookieItem>(key: string, item: Error | T): Error | T
Type Parameters
- T extends CookieItem
Parameters
- key: string
- item: Error | T
Returns Error | T
Inherited from Cookie.get_
- Defined in src/classes/cookie.ts:60

getName

getName(): string
Returns the name of the instance.

Returns string
Inherited from Cookie.getName
- Defined in src/classes/cookie.ts:170

getOptions

getOptions(): Options | undefined
Returns the options for the cookie.

Returns Options | undefined
Inherited from Cookie.getOptions
- Defined in src/classes/cookie.ts:184

getSeparator

getSeparator(): string
Returns the separator used to separate the cookie name from the cookie item key.

Returns string
Inherited from Cookie.getSeparator
- Defined in src/classes/cookie.ts:177

has

has<T extends CookieItem>(
    key: string,
    keys?: (keyof T)[],
    options?: HasOptions,
): boolean
Checks if an item exists in the cookies. Optionally you can specify the keys of the item that you want to check, if you don't specify any key the whole item will be checked.
Type Parameters
- T extends CookieItem
Parameters
- key: string
- Optionalkeys: (keyof T)[]
- Optionaloptions: HasOptions
Returns boolean
Overrides Cookie.has
- Defined in src/classes/sync-cookie.ts:78

`Protected`has_

has_<T extends CookieItem>(
keys: (keyof T)[] | undefined,
item: Error | T,
): boolean
Type Parameters
- T extends CookieItem
Parameters
- keys: (keyof T)[] | undefined
- item: Error | T
Returns boolean
Inherited from Cookie.has_
- Defined in src/classes/cookie.ts:140

remove

remove<T extends CookieItem>(
    key: string,
    keys?: (keyof T)[],
    options?: RemoveOptions,
): void | Error
Removes an item from the cookies. Optionally you can specify the keys of the item that you want to remove, if you don't specify any key the whole item will be removed.
Type Parameters
- T extends CookieItem
Parameters
- key: string
- Optionalkeys: (keyof T)[]
- Optionaloptions: RemoveOptions
Returns void | Error
Overrides Cookie.remove
- Defined in src/classes/sync-cookie.ts:49

`Protected`remove_

remove_(key: string, removed: void | Error): void | Error
Parameters
- key: string
- removed: void | Error
Returns void | Error
Inherited from Cookie.remove_
- Defined in src/classes/cookie.ts:71

set

set<T extends CookieItem>(
    key: string,
    item: T,
    keys?: (keyof T)[],
    options?: SetOptions,
): void | Error
Sets an item in the cookies. Optionally you can specify the keys of the item that you want to set, if you don't specify any key the whole item will be set.
Type Parameters
- T extends CookieItem
Parameters
- key: string
- item: T
- Optionalkeys: (keyof T)[]
- Optionaloptions: SetOptions
Returns void | Error
Overrides Cookie.set
- Defined in src/classes/sync-cookie.ts:57

`Protected`set_

set_<T extends CookieItem>(
    key: string,
    item: Error | T,
    set: void | Error,
): void | Error
Type Parameters
- T extends CookieItem
Parameters
- key: string
- item: Error | T
- set: void | Error
Returns void | Error
Inherited from Cookie.set_
- Defined in src/classes/cookie.ts:80

`Protected`set__

set__<T extends CookieItem>(
    item: T,
    keys: (keyof T)[],
    current: Error | T,
): Error | T
Type Parameters
- T extends CookieItem
Parameters
- item: T
- keys: (keyof T)[]
- current: Error | T
Returns Error | T
Inherited from Cookie.set__
- Defined in src/classes/cookie.ts:87

setOptions

setOptions(options: Options): void
Sets the options for the cookie.
Parameters
- options: Options
Returns void
Inherited from Cookie.setOptions
- Defined in src/classes/cookie.ts:191

Class SyncCookie<Options, GetOptions, SetOptions, ClearOptions, CopyOptions, HasOptions, RemoveOptions>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SyncCookie< Options, GetOptions, SetOptions, ClearOptions, CopyOptions, HasOptions, RemoveOptions,>

Properties

Protected Readonly_clear

Protected Readonly_get

Protected Readonly_has

Protected Readonly_remove

Protected Readonly_set

Protected Readonlyname

Protected Optionaloptions

Methods

clear

Parameters

Returns void | Error

Protectedclear_

Parameters

Returns void | Error

copy

Type Parameters

Parameters

Returns void | Error

Protectedcopy_

Type Parameters

Parameters

Returns void | Error

get

Type Parameters

Parameters

Returns Error | T

Protectedget_

Type Parameters

Parameters

Returns Error | T

getName

Returns string

getOptions

Returns Options | undefined

getSeparator

Returns string

has

Type Parameters

Parameters

Returns boolean

Protectedhas_

Type Parameters

Parameters

Returns boolean

remove

Type Parameters

Parameters

Returns void | Error

Protectedremove_

Parameters

Returns void | Error

set

Type Parameters

Parameters

Returns void | Error

Protectedset_

Type Parameters

Parameters

Returns void | Error

Protectedset__

Type Parameters

Parameters

Returns Error | T

setOptions

Parameters

Returns void

Settings

Returns SyncCookie<
Options,
GetOptions,
SetOptions,
ClearOptions,
CopyOptions,
HasOptions,
RemoveOptions,
>

`Protected` `Readonly`_clear

`Protected` `Readonly`_get

`Protected` `Readonly`_has

`Protected` `Readonly`_remove

`Protected` `Readonly`_set

`Protected` `Readonly`name

`Protected` `Optional`options

`Protected`clear_

`Protected`copy_

`Protected`get_

`Protected`has_

`Protected`remove_

`Protected`set_

`Protected`set__