Skip to content

Commit 2dee96e

Browse files
authored
Merge pull request #4 from klerick/3.x.x-json-api
perf(json-api-nestjs): new-version 3.x.x
2 parents 1c3d6b9 + c725407 commit 2dee96e

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

libs/json-api-nestjs/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,22 @@ export class ExtendUserController extends JsonBaseController<Users> {
9494

9595
For using swagger, you should only add [@nestjs/swagger](https://docs.nestjs.com/openapi/introduction)
9696

97-
## Reference Example
9897

99-
[example](https://github.com/klerick/nestjs-json-api/tree/master/apps/example) is an example project that demonstrates the usage of this module.
98+
## Filter operand
99+
100+
```typescript
101+
type FilterOperand = {
102+
in: string[], // is equal to the conditional of query "WHERE 'attribute_name' IN ('value1', 'value2')"
103+
nin: string[], // is equal to the conditional of query "WHERE 'attribute_name' NOT IN ('value1', 'value1')"
104+
eq: string, // is equal to the conditional of query "WHERE 'attribute_name' = 'value1'
105+
ne: string, // is equal to the conditional of query "WHERE 'attribute_name' <> 'value1'
106+
gte: string, // is equal to the conditional of query "WHERE 'attribute_name' >= 'value1'
107+
gt: string, // is equal to the conditional of query "WHERE 'attribute_name' > 'value1'
108+
lt: string, // is equal to the conditional of query "WHERE 'attribute_name' < 'value1'
109+
lte:string, // is equal to the conditional of query "WHERE 'attribute_name' <= 'value1'
110+
regexp: string, // is equal to the conditional of query "WHERE 'attribute_name' ~* value1
111+
some: string, // is equal to the conditional of query "WHERE 'attribute_name' && [value1]
112+
}
113+
```
114+
115+

0 commit comments

Comments
 (0)