Skip to content

Commit 6d7c5df

Browse files
committed
docs
1 parent 0246cfc commit 6d7c5df

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

projects/ngx-pwa/local-storage/src/lib/lib.service.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,10 @@ export class LocalStorage {
5454

5555
/**
5656
* Get an item value in storage.
57-
* The signature has many overloads due to validation, please refer to the documentation.
57+
* The signature has many overloads due to validation, **please refer to the documentation.**
58+
* Note you must pass the schema directly as the second argument.
59+
* Passing the schema in an object `{ schema }` is deprecated and only here for backward compatibility:
60+
* it may be removed in v9.
5861
* @see https://github.com/cyrilletuzi/angular-async-local-storage/blob/master/docs/VALIDATION.md
5962
* @param key The item's key
6063
* @returns The item's value if the key exists, `null` otherwise, wrapped in a RxJS `Observable`

0 commit comments

Comments
 (0)