typescript-nedb-orm

ORM for @seald-io/nedb written in TypeScript

How to install

npm install typescript-nedb-orm

or

yarn add typescript-nedb-orm

or

pnpm add typescript-nedb-orm

How to use

Create an objet extending ORM, parametrised with your class fields interface

Example:

import { IID, ORM } from 'typescript-nedb-orm'

interface IPerson extends IID {
    name: string
    email: string
}

class Person extends ORM<IPerson> 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:

const person = new Person({
    name: 'Luc',
    email: 'luc@luc.fr'
})

Save your object:

const savedPerson: IPerson = await person.save()

Fetch your objects in db:

const retrievedPersons: IPerson[] = await Person.find<IPerson>({
    email: 'luc@luc.fr'
})

Delete your object:

await person.delete()

Update your objects in db:

const updated: number = await Person.update<IPerson>(
    {
        name: 'Luc'
    },
    {
        email: 'luc@new.fr'
    }
)

Remove your objects in db:

const removed: number = await Person.remove<IPerson>({
    email: 'luc@new.fr'
})

Find one object in db:

const found: IPerson | null = await Person.findOne<IPerson>({
    name: 'Luc'
})

Find an object by id in db:

const foundById: IPerson | null = await Person.findById<IPerson>('kpOBxczJlr2R5S68')

Count the number of objects in db:

const count: number = await Person.count<IPerson>()

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

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 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) - see the LICENSE file for details.