[ADF-1586] Added Core services docs (#2582)

This commit is contained in:
Andy Stark
2017-11-01 10:04:42 +00:00
committed by Eugenio Romano
parent 092e07c545
commit c17abc4344
10 changed files with 228 additions and 122 deletions

29
docs/cookie.service.md Normal file
View File

@@ -0,0 +1,29 @@
# Cookie service
Stores key-value data items as browser cookies.
## Methods
`getItem(key: string): string | null` <br/>
Gets an item identified by `key`.
` setItem(key: string, data: string, expiration: Date | null, path: string | null): void ` <br/>
Stores an item under `key`.
## Details
This service uses browser [cookies](https://en.wikipedia.org/wiki/HTTP_cookie)
to store data in the form of key-value pairs. An optional `expiration` date can be
supplied for the cookie and a `path` can be used to reduce the chances of name
clashes with cookies from other sources.
Cookies have a storage size limit that varies between browsers but is often around
4KB. Consider using [web storage](storage.service.md) if you need to store data
beyond this size.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Storage service](storage.service.md)
<!-- seealso end -->