Skip to content
This repository was archived by the owner on Jun 22, 2021. It is now read-only.

Commit 629000c

Browse files
committed
docs: Starts adding docs.
1 parent 34d5b83 commit 629000c

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

docs/readme.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Facade
2+
3+
- [countEntities](#countentities)
4+
- [createEntity](#createentity)
5+
- [getEntities](#getentities)
6+
- [getEntity](#getentity)
7+
- [overwriteEntity](#overwriteentity)
8+
- [patchEntity](#patchentity)
9+
- [removeEntities](#removeentities)
10+
- [removeEntity](#removeentity)
11+
12+
### countEntities
13+
```ts
14+
const { count } = await facade.countEntities({ filter: {} });
15+
```
16+
17+
### createEntity
18+
```ts
19+
const { entity } = await facade.createEntity({ entity: { /* ... */ } });
20+
```
21+
22+
### getEntities
23+
```ts
24+
const { entities, nextCursor, previousCursor} = await facade.getEntities({
25+
filter: {},
26+
sort: { id: true },
27+
pagination: { limit: 10, forward: true, cursor: undefined },
28+
});
29+
```
30+
31+
### getEntity
32+
```ts
33+
const { entity } = await facade.getEntity({ id: { /* ... */ } });
34+
```
35+
36+
### overwriteEntity
37+
```ts
38+
const { entity } = await facade.overwriteEntity({
39+
id: { /* ... */ },
40+
entity: { /* ... */ },
41+
});
42+
```
43+
44+
### patchEntity
45+
```ts
46+
const { entity } = await facade.patchEntity({
47+
id: { /* ... */ },
48+
patch: { /* ... */ },
49+
});
50+
```
51+
52+
### removeEntities
53+
```ts
54+
await facade.removeEntities({
55+
filter: {},
56+
});
57+
```
58+
59+
### removeEntity
60+
```ts
61+
await facade.removeEntity({ id: { /* ... */ } });
62+
```

0 commit comments

Comments
 (0)