@odata2ts/odata-query-objects/README.md

Q-Objects are the magic sauce for the odata-query-builder and allow for renaming and type conversion

[![npm (scoped)](https://img.shields.io/npm/v/@odata2ts/odata-query-objects?style=for-the-badge)](https://www.npmjs.com/package/@odata2ts/odata-query-objects)

# OData Query Objects

Q-Objects are building blocks which are generated by [odata2ts](https://github.com/odata2ts/odata2ts).
They are the counterpart to the typescript model interfaces and allow for complex and powerful query semantics,
renaming and type conversion.

## Documentation
[Q-Objects Documentation](https://odata2ts.github.io/docs/category/q-objects)

Main documentation for the odata2ts eco system:
[https://odata2ts.github.io](https://odata2ts.github.io/)

## Tests
See folder [test](https://github.com/odata2ts/odata2ts/tree/main/packages/odata-query-objects/test)
for unit tests.

## Support, Feedback, Contributing
This project is open to feature requests, suggestions, bug reports, usage questions etc.
via [GitHub issues](https://github.com/odata2ts/odata2ts/issues).

Contributions and feedback are encouraged and always welcome.

See the [contribution guidelines](https://github.com/odata2ts/odata2ts/blob/main/CONTRIBUTING.md) for further information.

## Spirit
This project and this module have been created and are maintained in the following spirit:

* adhere to the **OData specification** as much as possible
  * support any OData service implementation which conforms to the spec
  * allow to work around faulty implementations if possible
* stability matters
  * exercise Test Driven Development
  * bomb the place with unit tests (code coverage > 95%)
  * ensure that assumptions & understanding are correct by creating integration tests

## Inspiration

The base idea for generating and using "Query Objects" stems from [QueryDsl](http://www.querydsl.com/).
[Jooq](https://www.jooq.org/) also works this way.

## License
MIT - see [License](./LICENSE).