Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ I actively welcome your pull requests:
6. Issue that pull request!


#### Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
#### Report bugs using Github's [issues](https://github.com/ndzhwr/json-base/issues/new)

I use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/ndzhwr/json-base/issues/new); it's that easy!

#### Write bug reports with detail, background, and sample code

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
2 changes: 1 addition & 1 deletion LICENCE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Régis NDIZIHIWE
Copyright (c) 2023 - Present Régis NDIZIHIWE

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Let's have a simple tutorial on how we can use this `json-base`. We're going to
2. Deleting data with del() api
3. Updating data with set() api
4. Adding data with add() api
5. Deleting All data with delAll() api

#### 0. Setting up jsondb in a project
Before starting to perform transactions to the database, let's
Expand Down Expand Up @@ -158,6 +159,19 @@ Enough for updating data, the next is to learn how to delete some records from t
}())
```


We can't finish without talking about how to delete all data from db in case you want . here are code example

```ts
import { delAll } from '@ndzhwr/json-base'

(async function(){
await delAll();
}())

```


🎉 Congrats! Now we've finished creating our CRUD operations on the models and I hope now you're able to consume the API and make your life easier.
*For more, jsdoc was used , hover on your imported function to see the documentation*

Expand Down
2 changes: 1 addition & 1 deletion index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ export * from './scripts/get.js'
export * from './scripts/set.js'
export * from './scripts/del.js'
export * from './scripts/add.js'

export * from './scripts/delAll'
Loading