{"_id":"@5minlab/serverless-typeorm","_rev":"1-0111ac9a0b5f8b82534452d85951fbfe","name":"@5minlab/serverless-typeorm","dist-tags":{"latest":"1.1.0"},"versions":{"1.1.0":{"name":"@5minlab/serverless-typeorm","version":"1.1.0","publishConfig":{"access":"public"},"description":"[](https://github.com/prettier/prettier) [](https://greenkeeper.io/) [![Travi","keywords":[],"main":"dist/citrus-serverless-typeorm.umd.js","module":"dist/citrus-serverless-typeorm.es5.js","typings":"dist/types/citrus-serverless-typeorm.d.ts","author":{"name":"if1live","email":"libsora25@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/5minlab/citrus-serverless-typeorm.git"},"license":"MIT","engines":{"node":">=6.0.0"},"scripts":{"lint":"tslint --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*.ts'","prebuild":"rimraf dist","build":"tsc --module commonjs && rollup -c rollup.config.ts && typedoc --out docs --target es6 --theme minimal --mode file src","start":"rollup -c rollup.config.ts -w","test":"jest --coverage","test:watch":"jest --coverage --watch","test:prod":"npm run lint && npm run test -- --no-cache","deploy-docs":"ts-node tools/gh-pages-publish","report-coverage":"cat ./coverage/lcov.info | coveralls","commit":"git-cz","semantic-release":"semantic-release","semantic-release-prepare":"ts-node tools/semantic-release-prepare","precommit":"lint-staged","travis-deploy-once":"travis-deploy-once","prepush":"npm run test:prod && npm run build","commitmsg":"commitlint -E HUSKY_GIT_PARAMS"},"lint-staged":{"{src,test}/**/*.ts":["prettier --write","git add"]},"config":{"commitizen":{"path":"node_modules/cz-conventional-changelog"}},"jest":{"transform":{".(ts|tsx)":"ts-jest"},"testEnvironment":"node","testRegex":"(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$","moduleFileExtensions":["ts","tsx","js"],"coveragePathIgnorePatterns":["/node_modules/","/test/"],"coverageThreshold":{"global":{"branches":90,"functions":95,"lines":95,"statements":95}},"collectCoverageFrom":["src/*.{js,ts}"]},"prettier":{"semi":false,"singleQuote":true},"commitlint":{"extends":["@commitlint/config-conventional"]},"devDependencies":{"@commitlint/cli":"^8.1.0","@commitlint/config-conventional":"^8.1.0","@types/jest":"^24.0.18","@types/node":"^12.7.2","colors":"^1.3.3","commitizen":"^4.0.3","coveralls":"^3.0.6","cross-env":"^5.2.0","cz-conventional-changelog":"^3.0.2","husky":"^3.0.4","jest":"^24.9.0","jest-config":"^24.9.0","lint-staged":"^9.2.4","lodash.camelcase":"^4.3.0","prettier":"^1.18.2","prompt":"^1.0.0","replace-in-file":"^4.1.3","rimraf":"^3.0.0","rollup":"^1.20.2","rollup-plugin-commonjs":"^10.0.2","rollup-plugin-json":"^4.0.0","rollup-plugin-node-resolve":"^5.2.0","rollup-plugin-sourcemaps":"^0.4.2","rollup-plugin-typescript2":"^0.23.0","semantic-release":"^15.13.24","shelljs":"^0.8.3","sqlite3":"^4.1.0","travis-deploy-once":"^5.0.11","ts-jest":"^24.0.2","ts-node":"^8.3.0","tslint":"^5.19.0","tslint-config-prettier":"^1.18.0","tslint-config-standard":"^8.0.1","typedoc":"^0.15.0","typescript":"^3.5.3"},"dependencies":{"reflect-metadata":"^0.1.13","rollup-plugin-node-builtins":"^2.1.2","typeorm":"^0.2.18"},"bugs":{"url":"https://github.com/5minlab/citrus-serverless-typeorm/issues"},"homepage":"https://github.com/5minlab/citrus-serverless-typeorm#readme","directories":{"doc":"docs","test":"test"},"gitHead":"389a043a7d9224f8e407751627a4f930341a01ba","_id":"@5minlab/serverless-typeorm@1.1.0","_nodeVersion":"10.16.3","_npmVersion":"6.11.2","dist":{"integrity":"sha512-0GMOqgGkWog2G8aIgwPE3vMKcW4Zma4g/1Oz5Mk9lsBzoPtW3Tm+DJhQHN18Dh8UsTSCbUSeGofLfWGoeC0Zcg==","shasum":"d02b7d5a7e7704f67f8dae06241dc9ac11b83375","tarball":"https://registry.npmjs.org/@5minlab/serverless-typeorm/-/serverless-typeorm-1.1.0.tgz","fileCount":19,"unpackedSize":85119,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdbNLGCRA9TVsSAnZWagAAStEP/2m3X1w4CfJJCQsshWNK\nB6HZBKlOxKWt+01LNyzKTDQ2n3wpLTuS/eXMUn4V4OAsy4jyLCaf53gk1Dg/\nNsvVk9724yHukXMDocZ9tEoJXQhroFUuL3l72z30yScg0Dr+neO06BR80fMn\ngWbOatwDo23BIKxhX4Fz923BJ8LKeqdAoHlkGujHn0kIp+55tS8LPw6otJNl\nEAXLUQyMU6dsFu7vGa2bWANpubF6Wv6faVt7WEcxSk+hqtpmtaQeQ6pvWSu4\n6jmBDG+VuP18rtXH3bMPqHf38wrnqhF23EVdOml+x7nT9u3OkIM0V+ZczBtO\nIjRj83HKo5Gwy6+FADAkTLNiQk1vtTXxvyPDn8Sd0aXOBT9mzRyr21zWiMde\nBdSbTwgAD8U21SlWGOjDstunRJzWhd2dJClNrcaIz1hledRflAuAsQPeZOkO\nvagL+Z+jni7Stkgj2i2gs9Hnh1yj2R3AQOsqPa+1T2BH9pQmZbQYgbUrcN2O\n2cz99Q+scwpCYef8Da09wbabOGtp5CtyenaQaOIVYJuIhW9+U009C/7rdiro\nTkAXunWY5U1r87L6dsxoWJi7EKBQPIHjM7p92PyA+0WlD9YPkxzgRQs/ab1A\nIs7qT3dZ9FsCZ2IOHg1y2G7N7sPvBMiuNNf1cmv66kyjLER37x8T7hbzOlV3\neZiJ\r\n=Y/QM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBtLBVs+moN1pBpz8BE9lfu/7+jamjpUkOK5FK9GXpN/AiEA+5hrfUbOqjPE8BEzSbbFmmOHg08gZ2PZ6szDMmCIFCs="}]},"maintainers":[{"name":"if1live","email":"libsora25@gmail.com"},{"name":"sapphiredev","email":"info@sapphire.sh"}],"_npmUser":{"name":"if1live","email":"libsora25@gmail.com"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/serverless-typeorm_1.1.0_1567412933305_0.0290325963187672"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-02T08:28:53.001Z","1.1.0":"2019-09-02T08:28:53.427Z","modified":"2022-04-04T10:48:35.354Z"},"maintainers":[{"name":"if1live","email":"libsora25@gmail.com"},{"name":"sapphiredev","email":"info@sapphire.sh"}],"description":"[](https://github.com/prettier/prettier) [](https://greenkeeper.io/) [![Travi","homepage":"https://github.com/5minlab/citrus-serverless-typeorm#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/5minlab/citrus-serverless-typeorm.git"},"author":{"name":"if1live","email":"libsora25@gmail.com"},"bugs":{"url":"https://github.com/5minlab/citrus-serverless-typeorm/issues"},"license":"MIT","readme":"# TypeScript library starter\n\n[](https://github.com/prettier/prettier)\n[](https://greenkeeper.io/)\n[](https://travis-ci.org/alexjoverm/typescript-library-starter)\n[](https://coveralls.io/github/alexjoverm/typescript-library-starter)\n[](https://david-dm.org/alexjoverm/typescript-library-starter?type=dev)\n[](https://paypal.me/AJoverMorales)\n\nA starter project that makes creating a TypeScript library extremely easy.\n\n\n\n### Usage\n\n```bash\ngit clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME\ncd YOURFOLDERNAME\n\n# Run npm install and write your library name when asked. That's all!\nnpm install\n```\n\n**Start coding!** `package.json` and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name.\n\n### Features\n\n - Zero-setup. After running `npm install` things will setup for you :wink:\n - **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/)\n - Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)**\n - **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency\n - **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)**\n - Automatic types `(*.d.ts)` file generation\n - **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report\n - (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks)\n\n### Importing library\n\nYou can import the generated bundle to use the whole library generated by this starter:\n\n```javascript\nimport myLib from 'mylib'\n```\n\nAdditionally, you can import the transpiled modules from `dist/lib` in case you have a modular library:\n\n```javascript\nimport something from 'mylib/dist/lib/something'\n```\n\n### NPM scripts\n\n - `npm t`: Run test suite\n - `npm start`: Run `npm run build` in watch mode\n - `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)\n - `npm run test:prod`: Run linting and generate coverage\n - `npm run build`: Generate bundles and typings, create docs\n - `npm run lint`: Lints code\n - `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)\n\n### Excluding peerDependencies\n\nOn library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in [Rollup docs](https://rollupjs.org/#peer-dependencies) how to do that.\n\nGood news: the setup is here for you, you must only include the dependency name in `external` property within `rollup.config.js`. For example, if you want to exclude `lodash`, just write there `external: ['lodash']`.\n\n### Automatic releases\n\n_**Prerequisites**: you need to create/login accounts and add your project to:_\n - [npm](https://www.npmjs.com/)\n - [Travis CI](https://travis-ci.org)\n - [Coveralls](https://coveralls.io)\n\n_**Prerequisite for Windows**: Semantic-release uses\n**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to\ninstall\n[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools)\nusing this command:_\n\n```bash\nnpm install --global --production windows-build-tools\n```\n\n#### Setup steps\n\nFollow the console instructions to install semantic release and run it (answer NO to \"Do you want a `.travis.yml` file with semantic-release setup?\").\n\n_Note: make sure you've setup `repository.url` in your `package.json` file_\n\n```bash\nnpm install -g semantic-release-cli\nsemantic-release-cli setup\n# IMPORTANT!! Answer NO to \"Do you want a `.travis.yml` file with semantic-release setup?\" question. It is already prepared for you :P\n```\n\nFrom now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits.\n\nAutomatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library)\n\n### Git Hooks\n\nThere is already set a `precommit` hook for formatting your code with Prettier :nail_care:\n\nBy default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure:\n - You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog)\n - Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push`\n\nThis makes more sense in combination with [automatic releases](#automatic-releases)\n\n### FAQ\n\n#### `Array.prototype.from`, `Promise`, `Map`... is undefined?\n\nTypeScript or Babel only provides down-emits on syntactical features (`class`, `let`, `async/await`...), but not on functional features (`Array.prototype.find`, `Set`, `Promise`...), . For that, you need Polyfills, such as [`core-js`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`).\n\nFor a library, `core-js` plays very nicely, since you can import just the polyfills you need:\n\n```javascript\nimport \"core-js/fn/array/find\"\nimport \"core-js/fn/string/includes\"\nimport \"core-js/fn/promise\"\n...\n```\n\n#### What is `npm install` doing on first run?\n\nIt runs the script `tools/init` which sets up everything for you. In short, it:\n - Configures RollupJS for the build, which creates the bundles\n - Configures `package.json` (typings file, main file, etc)\n - Renames main src and test files\n\n#### What if I don't want git-hooks, automatic releases or semantic-release?\n\nThen you may want to:\n - Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit\n - Remove `npm run semantic-release` from `.travis.yml`\n\n#### What if I don't want to use coveralls or report my coverage?\n\nRemove `npm run report-coverage` from `.travis.yml`\n\n## Resources\n\n- [Write a library using TypeScript library starter](https://dev.to/alexjoverm/write-a-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/)\n- [πΊ Create a TypeScript Library using typescript-library-starter](https://egghead.io/lessons/typescript-create-a-typescript-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/)\n- [Introducing TypeScript Library Starter Lite](https://blog.tonysneed.com/2017/09/15/introducing-typescript-library-starter-lite/) by [@tonysneed](https://github.com/tonysneed)\n\n## Projects using `typescript-library-starter`\n\nHere are some projects that use `typescript-library-starter`:\n\n- [NOEL - A universal, human-centric, replayable event emitter](https://github.com/lifenautjoe/noel)\n- [droppable - A library to give file dropping super-powers to any HTML element.](https://github.com/lifenautjoe/droppable)\n- [redis-messaging-manager - Pubsub messaging library, using redis and rxjs](https://github.com/tomyitav/redis-messaging-manager)\n\n## Credits\n\nMade with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):\n\n\n\n| [![](\"https://avatars.githubusercontent.com/u/6052309?v=3\")
Ciro](https://www.linkedin.com/in/ciro-ivan-agullΓ³-guarinos-42109376)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=k1r0s \"Code\") [π§](#tool-k1r0s \"Tools\") | [![](\"https://avatars.githubusercontent.com/u/947523?v=3\")
Marius Schulz](https://blog.mariusschulz.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=mariusschulz \"Documentation\") | [![](\"https://avatars.githubusercontent.com/u/4152819?v=3\")
Alexander Odell](https://github.com/alextrastero)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=alextrastero \"Documentation\") | [![](\"https://avatars1.githubusercontent.com/u/8728882?v=3\")
Ryan Ham](https://github.com/superamadeus)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=superamadeus \"Code\") | [![](\"https://avatars1.githubusercontent.com/u/8458838?v=3\")
Chi](https://consiiii.me)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW \"Code\") [π§](#tool-ChinW \"Tools\") [π](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW \"Documentation\") | [![](\"https://avatars2.githubusercontent.com/u/2856501?v=3\")
Matt Mazzola](https://github.com/mattmazzola)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=mattmazzola \"Code\") [π§](#tool-mattmazzola \"Tools\") | [![](\"https://avatars0.githubusercontent.com/u/2664047?v=3\")
Sergii Lischuk](http://leefrost.github.io)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=Leefrost \"Code\") |\n| :---: | :---: | :---: | :---: | :---: | :---: | :---: |\n| [![](\"https://avatars1.githubusercontent.com/u/618922?v=3\")
Steve Lee](http;//opendirective.com)
[π§](#tool-SteveALee \"Tools\") | [![](\"https://avatars0.githubusercontent.com/u/5127501?v=3\")
Flavio Corpa](http://flaviocorpa.com)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=kutyel \"Code\") | [![](\"https://avatars2.githubusercontent.com/u/22561997?v=3\")
Dom](https://github.com/foreggs)
[π§](#tool-foreggs \"Tools\") | [![](\"https://avatars1.githubusercontent.com/u/755?v=4\")
Alex Coles](http://alexbcoles.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=myabc \"Documentation\") | [![](\"https://avatars2.githubusercontent.com/u/1093738?v=4\")
David Khourshid](https://github.com/davidkpiano)
[π§](#tool-davidkpiano \"Tools\") | [![](\"https://avatars0.githubusercontent.com/u/7225802?v=4\")
AarΓ³n GarcΓa HervΓ‘s](https://aarongarciah.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=aarongarciah \"Documentation\") | [![](\"https://avatars2.githubusercontent.com/u/13683986?v=4\")
Jonathan Hart](https://www.stuajnht.co.uk)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=stuajnht \"Code\") |\n| [![](\"https://avatars0.githubusercontent.com/u/13509204?v=4\")
Sanjiv Lobo](https://github.com/Xndr7)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=Xndr7 \"Documentation\") | [![](\"https://avatars3.githubusercontent.com/u/7473800?v=4\")
Stefan Aleksovski](https://github.com/sAleksovski)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=sAleksovski \"Code\") | [![](\"https://avatars2.githubusercontent.com/u/8853426?v=4\")
dev.peerapong](https://github.com/devpeerapong)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=devpeerapong \"Code\") | [![](\"https://avatars0.githubusercontent.com/u/22260722?v=4\")
Aaron Groome](http://twitter.com/Racing5372)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=Racing5372 \"Documentation\") | [![](\"https://avatars3.githubusercontent.com/u/180963?v=4\")
Aaron Reisman](https://github.com/lifeiscontent)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=lifeiscontent \"Code\") | [![](\"https://avatars1.githubusercontent.com/u/32557482?v=4\")
kid-sk](https://github.com/kid-sk)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=kid-sk \"Documentation\") | [![](\"https://avatars0.githubusercontent.com/u/1503089?v=4\")
Andrea Gottardi](http://about.me/andreagot)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=AndreaGot \"Documentation\") |\n| [![](\"https://avatars3.githubusercontent.com/u/1375860?v=4\")
Yogendra Sharma](http://TechiesEyes.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=Yogendra0Sharma \"Documentation\") | [![](\"https://avatars3.githubusercontent.com/u/7407177?v=4\")
Rayan Salhab](http://linkedin.com/in/rayan-salhab/)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=cyphercodes \"Code\") |\n\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome!\n","readmeFilename":"README.md"}