[ADF-2764] Applied new doc tool features to core library (#3383)

This commit is contained in:
Andy Stark
2018-05-23 19:30:48 +01:00
committed by Eugenio Romano
parent 5831bc1d77
commit 41777e0540
97 changed files with 965 additions and 788 deletions

View File

@@ -12,19 +12,21 @@ Stores key-value data items as browser cookies.
### Methods
- `getItem(key: string = null): string | null`<br/>
- **clear**()<br/>
- **getItem**(key: `string` = `null`): `string | null`<br/>
Retrieves a cookie by its key.
- `key: string = null` - Key to identify the cookie
- _key:_ `string` - Key to identify the cookie
- **Returns** `string | null` - The cookie data or null if it is not found
- `isEnabled(): boolean`<br/>
- **isEnabled**(): `boolean`<br/>
Checks if cookies are enabled.
- **Returns** `boolean` - True if enabled, false otherwise
- `setItem(key: string = null, data: string = null, expiration: Date | null = null, path: string | null = null)`<br/>
- **setItem**(key: `string` = `null`, data: `string` = `null`, expiration: `Date | null` = `null`, path: `string | null` = `null`)<br/>
Sets a cookie.
- `key: string = null` - Key to identify the cookie
- `data: string = null` - Data value to set for the cookie
- `expiration: Date | null = null` - Expiration date of the data
- `path: string | null = null` - "Pathname" to store the cookie
- _key:_ `string` - Key to identify the cookie
- _data:_ `string` - Data value to set for the cookie
- _expiration:_ `Date | null` - Expiration date of the data
- _path:_ `string | null` - "Pathname" to store the cookie
## Details