Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/levg34/typescript-nedb-orm
ORM for @seald-io/nedb written in TypeScript
https://github.com/levg34/typescript-nedb-orm
nedb odm orm typescript
Last synced: about 4 hours ago
JSON representation
ORM for @seald-io/nedb written in TypeScript
- Host: GitHub
- URL: https://github.com/levg34/typescript-nedb-orm
- Owner: levg34
- License: gpl-3.0
- Created: 2022-12-14T18:08:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-02T18:43:43.000Z (12 months ago)
- Last Synced: 2024-11-12T10:48:37.966Z (7 days ago)
- Topics: nedb, odm, orm, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/typescript-nedb-orm
- Size: 185 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typescript-nedb-orm
ORM for [@seald-io/nedb](https://github.com/seald/nedb) written in TypeScript
[](https://github.com/levg34/typescript-nedb-orm/actions/workflows/e2e-tests.yml)
[](https://github.com/levg34/typescript-nedb-orm/actions/workflows/node.js.yml)
[](https://codecov.io/gh/levg34/typescript-nedb-orm)
[](https://github.com/prettier/prettier)
## How to install
```bash
npm install typescript-nedb-orm
```
or
```bash
yarn add typescript-nedb-orm
```
or
```bash
pnpm add typescript-nedb-orm
```
## How to use
Create an objet extending ORM, parametrised with your class fields interface
Example:
```typescript
import { IID, ORM } from 'typescript-nedb-orm'
interface IPerson extends IID {
name: string
email: string
}
class Person extends ORM implements IPerson {
name: string
email: string
constructor(person: IPerson) {
super(person)
this.name = person.name
this.email = person.email
}
}
```
Then, you can use it.
Create your object as you would normaly:
```typescript
const person = new Person({
name: 'Luc',
email: '[email protected]'
})
```
Save your object:
```typescript
const savedPerson: IPerson = await person.save()
```
Fetch your objects in db:
```typescript
const retrievedPersons: IPerson[] = await Person.find({
email: '[email protected]'
})
```
Delete your object:
```typescript
await person.delete()
```
Update your objects in db:
```typescript
const updated: number = await Person.update(
{
name: 'Luc'
},
{
email: '[email protected]'
}
)
```
Remove your objects in db:
```typescript
const removed: number = await Person.remove({
email: '[email protected]'
})
```
Find one object in db:
```typescript
const found: IPerson | null = await Person.findOne({
name: 'Luc'
})
```
Find an object by id in db:
```typescript
const foundById: IPerson | null = await Person.findById('kpOBxczJlr2R5S68')
```
Count the number of objects in db:
```typescript
const count: number = await Person.count()
```
Have fun! :)
## Project Roadmap
This roadmap outlines the vision I have for the future of TypeScript-NEDB-ORM. It provides insights into my current focus and the improvements I'm planning. While I aim to stick to this roadmap, priorities might shift based on feedback and challenges that arise.
### Planned Features & Improvements
#### 1. **Support for Multiple Classes**
**Issue**: [#2](https://github.com/levg34/typescript-nedb-orm/issues/2)
Description: I'm looking to enhance the ORM to allow usage with multiple classes. This would provide developers with more flexibility to create complex data structures and relationships.
Possible Approaches:
- Using multiple databases (files) and maintaining a map of the databases within the ORM class.
- Having a single database system with a protected class keyword or other distinguishing parameters.
I'm still considering the best approach to implement this. If you have any feedback or insights, your input would be invaluable. Please share your thoughts on the issue thread.
### Future Considerations
- **Enhanced Documentation**: I plan to add more tutorials, examples (ready to run in StackBlitz), and in-depth guides.
- **Extended Query Capabilities**: Aiming to provide more tools and flexibility in data retrieval and manipulation.
### Your Input Matters
Feedback and ideas from the community are always welcome. If you have suggestions or want to contribute to a feature on the roadmap, please follow the contribution guidelines or open a new issue for discussion.
## Contributing
Thank you for your interest in contributing to the TypeScript-NEDB-ORM! Contributions are valued and help enhance this project.
### How to Contribute
1. Fork the repository and create your branch from `main`.
2. Clone the forked repository to your local machine.
3. Install the required dependencies using `npm install`.
4. Make your changes, following these coding style guidelines:
- No semicolon at the end of lines.
- Use single quotes instead of double quotes.
- Indent with 4 spaces for TS and JS files, and 2 spaces for JSON or HTML.
- You can run `npm run format` to format your code before pushing.
5. Ensure that the code passes the coverage requirements:
- Add tests for the changes made.
- Run `npx jest -- --coverage` to check if the code passes the coverage requirements.
6. Ensure that the code passes the linting requirements:
- Run `npm run lint`
7. Update the documentation (`README.md`) to reflect your changes.
8. Commit your changes and push them to your forked repository.
9. Create a pull request to the `main` branch of the original repository.
### Reporting Issues
If you encounter any issues or have suggestions, please [open an issue](https://github.com/levg34/typescript-nedb-orm/issues) on GitHub.
Thank you for your contributions! This project is maintained by one person, and your efforts are greatly appreciated.
## License
This project is licensed under the [GNU General Public License v3.0 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0.en.html) - see the [LICENSE](LICENSE) file for details.