https://github.com/marc-aurele-besner/faunadb-utility
Set of useful helper functions to use with FaunaDB
https://github.com/marc-aurele-besner/faunadb-utility
fauna faunadb typescript utility
Last synced: about 2 months ago
JSON representation
Set of useful helper functions to use with FaunaDB
- Host: GitHub
- URL: https://github.com/marc-aurele-besner/faunadb-utility
- Owner: marc-aurele-besner
- License: mit
- Created: 2022-10-31T11:53:09.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T10:14:38.000Z (about 1 year ago)
- Last Synced: 2024-05-14T11:32:48.164Z (about 1 year ago)
- Topics: fauna, faunadb, typescript, utility
- Language: TypeScript
- Homepage:
- Size: 188 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/js/faunadb-utility)
# faunadb-utility
```
__ _ _ _ _ _ _ _
/ _| | | | | | (_) (_) |
| |_ __ _ _ _ _ __ __ _ __| | |__ ______ _ _| |_ _| |_| |_ _ _
| _/ _` | | | | '_ \ / _` |/ _` | '_ \______| | | | __| | | | __| | | |
| || (_| | |_| | | | | (_| | (_| | |_) | | |_| | |_| | | | |_| |_| |
|_| \__,_|\__,_|_| |_|\__,_|\__,_|_.__/ \__,_|\__|_|_|_|\__|\__, |
__/ |
|___/
```
## Installation
```
npm install faunadb-utility
```
or
```
yarn add faunadb-utility
```
## Directories
- [src/](./src/)
- [.eslintrc.js](./.eslintrc.js)
- [.prettierrc](./.prettierrc)
- [CONTRIBUTING.md](./CONTRIBUTING.md)
- [LICENSE](./LICENSE)
- [README.md](./README.md)
- [awesome-readme.config.js](./awesome-readme.config.js)
- [package-lock.json](./package-lock.json)
- [package.json](./package.json)
- [tsconfig.json](./tsconfig.json)
- [tslint.json](./tslint.json)
## Usage
```ts
import fauna from "faunadb-utility"
```
```js
const fauna = require('faunadb-utility');
```
### Functions
- `createClasses` : Create a class in fauna. (Collection)
- `createFaunaDocument` : Create a fauna document.
- `createIndexes` : Create a index in fauna.
- `deleteFaunaDocument` : Delete a fauna document.
- `faunaClient` : Create a fauna client.
- `queryAllByFaunaIndexes` : Query all documents by fauna indexes.
- `queryTermByFaunaIndexes` : Query documents by fauna indexes and term.
- `queryTermsByFaunaIndexes` : Query documents by fauna indexes and terms.
- `updateFaunaDocument` : Update a fauna document.
## Directory Tree
```
faunadb-utility/
│ .eslintrc.js
│ .prettierrc
│ CONTRIBUTING.md
│ LICENSE
│ README.md
│ awesome-readme.config.js
│ package-lock.json
│ package.json
│ tsconfig.json
│ tslint.json
└─── src/
│ README.md
│ createClasses.ts
│ createFaunaDocument.ts
│ createIndexes.ts
│ deleteFaunaDocument.ts
│ faunaClient.ts
│ index.ts
│ queryAllByFaunaIndexes.ts
│ queryTermByFaunaIndexes.ts
│ queryTermsByFaunaIndexes.ts
│ updateFaunaDocument.ts
```
## Don't hesitate to contribute to this project.