Class TokenStorage

Hierarchy

TokenStorage
- GlobalStorage

Index

Constructors

Properties

origin temporary tokenData GLOBAL WEB_STORAGE hmac

Accessors

Methods

_saveToken saveToken signPath update create parse

Constructors

constructor

new TokenStorage(origin: string, token?: null | string, temporary?: boolean): TokenStorage
Parameters
- origin: string
  
  The origin where the token belongs to
- Optional token: null | string
  
  The initial token
- Optional temporary: boolean
  
  If the token should be saved temporary or permanently
Returns TokenStorage
- Defined in lib/intersection/TokenStorage.ts:76

Properties

origin

origin: string

The origin of the token

temporary

temporary: boolean

Indicates if the token should keep temporary only or should be persisted for later sessions

tokenData

tokenData: null | TokenData

The actual stored token

`Static` GLOBAL

GLOBAL: typeof GlobalStorage

`Static` WEB_STORAGE

WEB_STORAGE: typeof WebStorage

`Static` hmac

hmac: ((message: string, key: string) => Promise<string>) = hmac

Type declaration

- (message: string, key: string): Promise<string>
- Calculates a Keyed-Hash Message Authentication Code (HMAC) from a message and a key.
  
  Returns
  Parameters
  - message: string
  - key: string
  Returns Promise<string>

Accessors

token

get token(): string
Get the stored token

Returns
The token or undefined, if no token is available

Returns string
- Defined in lib/intersection/TokenStorage.ts:63

Methods

`Protected` _saveToken

_saveToken(origin: string, token: null | string, temporary: boolean): void
Protected
Use the underlying storage implementation to save the token

Returns

Deprecated
Use TokenStorage#saveToken instead
Parameters
- origin: string
  
  The origin where the token belongs to
- token: null | string
  
  The initial token
- temporary: boolean
  
  If the token should be saved temporary or permanently
Returns void
- Defined in lib/intersection/TokenStorage.ts:109

`Protected` saveToken

saveToken(origin: string, token: null | string, temporary: boolean): void
Use the underlying storage implementation to save the token

Returns
Parameters
- origin: string
  
  The origin where the token belongs to
- token: null | string
  
  The initial token
- temporary: boolean
  
  If the token should be saved temporary or permanently
Returns void
- Defined in lib/intersection/TokenStorage.ts:89

signPath

signPath(resource: string, sign?: boolean): Promise<string>
Derives a resource token from the stored origin token and signs the resource with the generated resource token

Returns
A resource token which can only be used to access the specified resource
Parameters
- resource: string
  
  The resource which will be accessible with the returned token
- sign: boolean = true
  
  Sign the given resource with a token, if sign is false the resource will only be encoded to a path
Returns Promise<string>
- Defined in lib/intersection/TokenStorage.ts:133

update

update(token: null | string): void
Update the token for the givin origin, the operation may be asynchronous
Parameters
- token: null | string
  
  The token to store or null to remove the token
Returns void
- Defined in lib/intersection/TokenStorage.ts:115

`Static` create

create(origin: string): Promise<TokenStorage>
Parameters
- origin: string
Returns Promise<TokenStorage>
- Defined in lib/intersection/TokenStorage.ts:67

`Static` parse

parse(token: string): TokenData
Parse a token string in its components

Returns
The parsed token data
Parameters
- token: string
  
  The token string to parse, time values are returned as timestamps
Returns TokenData
- Defined in lib/intersection/TokenStorage.ts:49

Generated using TypeDoc