|
| 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({ |
| 15 | + filter: { foo: 'bar' }, |
| 16 | +}); |
| 17 | +``` |
| 18 | + |
| 19 | +### createEntity |
| 20 | +```ts |
| 21 | +const { entity } = await facade.createEntity({ |
| 22 | + entity: { id: 'example_id', foo: 'bar' }, |
| 23 | +}); |
| 24 | +``` |
| 25 | + |
| 26 | +### getEntities |
| 27 | +```ts |
| 28 | +const { entities, nextCursor, previousCursor } = await facade.getEntities({ |
| 29 | + filter: { foo: 'bar' }, |
| 30 | + sort: { id: true }, |
| 31 | + pagination: { limit: 10, forward: true, cursor: undefined }, |
| 32 | +}); |
| 33 | +const secondPage = await facade.getEntities({ |
| 34 | + filter: { foo: 'bar' }, |
| 35 | + sort: { id: true }, |
| 36 | + pagination: { limit: 10, forward: true, cursor: nextCursor }, |
| 37 | +}); |
| 38 | +const firstPage = await facade.getEntities({ |
| 39 | + filter: { foo: 'bar' }, |
| 40 | + sort: { id: true }, |
| 41 | + pagination: { limit: 10, forward: false, cursor: secondPage.previousCursor }, |
| 42 | +}); |
| 43 | +``` |
| 44 | + |
| 45 | +### getEntity |
| 46 | +```ts |
| 47 | +const { entity } = await facade.getEntity({ |
| 48 | + id: { id: 'example_id' }, |
| 49 | +}); |
| 50 | +``` |
| 51 | + |
| 52 | +### overwriteEntity |
| 53 | +```ts |
| 54 | +const { entity } = await facade.overwriteEntity({ |
| 55 | + id: { id: 'example_id' }, |
| 56 | + entity: { id: 'example_id', foo: 'bar' }, |
| 57 | +}); |
| 58 | +``` |
| 59 | + |
| 60 | +### patchEntity |
| 61 | +```ts |
| 62 | +const { entity } = await facade.patchEntity({ |
| 63 | + id: { id: 'example_id' }, |
| 64 | + patch: { foo: 'bar' }, |
| 65 | +}); |
| 66 | +``` |
| 67 | + |
| 68 | +### removeEntities |
| 69 | +```ts |
| 70 | +await facade.removeEntities({ |
| 71 | + filter: { foo: 'bar' }, |
| 72 | +}); |
| 73 | +``` |
| 74 | + |
| 75 | +### removeEntity |
| 76 | +```ts |
| 77 | +await facade.removeEntity({ |
| 78 | + id: { id: 'example_id' }, |
| 79 | +}); |
| 80 | +``` |
0 commit comments