\n A JavaScript library that provides a 'ramsey/uuid'-like interface for the uuid package.\n
\n\n@actually_connor/uuid is a JavaScript library for generating and working with universally unique\nidentifiers (UUIDs). It provides a [ramsey/uuid][ramseyuuid]-like interface to the [uuid][] package that\n\nThis project adheres to a [code of conduct](CODE_OF_CONDUCT.md).\nBy participating in this project and its community, you are expected to\nuphold this code.\n\n## Quickstart\n\n1. Install\n```bash\nnpm i --save @actually_connor/uuid\n```\n\n2. Generate a UUID (ES6 module syntax)\n```javascript\nimport { Uuid } from '@actually_connor/uuid';\nconst uuid = Uuid.uuid4();\n```\n\n... or using CommonJS syntax:\n```javascript\nconst { Uuid } = require('@actually_connor/uuid');\nconst uuid = Uuid.uuid4();\n```\n\n## Documentation\n\n[@actually_connor/uuid docs](https://uuid.connorsmyth.com/Uuid.html)\n\n## Use in Database - MySQL\n\nThe recommended use for saving UUID values in the database would be to create a `BINARY(16)` column in the database.\nWhen persisting the UUIDs you can `UNHEX` the hexadecimal representation of the UUID.\n\n### TypeORM\n```javascript\nawait this.model\n .createQueryBuilder()\n .insert()\n .into(Table)\n .values({\n uuid: Uuid.uuid4().getBuffer(),\n })\n .execute();\n```\n\n```javascript\nawait this.model\n .createQueryBuilder()\n .where('uuid = :uuid', { uuid: uuid.getBuffer() })\n .getOne();\n```\n\n## Contributing\n\nContributions are welcome! To contribute, please familiarize yourself with\n[CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Copyright and License\n\nThe @actually_connor/uuid library is copyright © [Connor Smyth](https://connorsmyth.com) and\nlicensed for use under the MIT License (MIT). Please see [LICENSE][] for more\ninformation.\n\n[uuid]: https://www.npmjs.com/package/uuid\n[rfc4122]: http://tools.ietf.org/html/rfc4122\n[conduct]: https://github.com/ActuallyConnor/uuid/blob/main/CODE_OF_CONDUCT.md\n[ramseyuuid]: https://github.com/ramsey/uuid\n[npm]: https://www.npmjs.com/\n[contributing.md]: https://github.com/ActuallyConnor/uuid/blob/main/CONTRIBUTING.md\n[license]: https://github.com/ActuallyConnor/uuid/blob/main/LICENSE\n","readmeFilename":"README.md"}