Skip to content

Commit 94c5f95

Browse files
committed
documenting identity keys
1 parent 9fe81db commit 94c5f95

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/prototype/identity-keys.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
@function can-query-logic.prototype.identityKeys identityKeys
22
@parent can-query-logic.prototype
3+
4+
5+
@description Return the identity keys.
6+
7+
@signature `queryLogic.identityKeys()`
8+
9+
Return the identity keys used to identity instances associated with the query logic:
10+
11+
```js
12+
import QueryLogic from "can-query-logic";
13+
14+
var queryLogic = new QueryLogic({
15+
identity: ["_id"]
16+
});
17+
18+
queryLogic.identityKeys() //-> ["_id"]
19+
```
20+
21+
@return {Array<String>} An Array of the identity keys.

0 commit comments

Comments
 (0)