{"_id":"@emjimadhu/firebase-helpers","_rev":"1-d8c9f65558f7d710dfa7d5b7e8243764","name":"@emjimadhu/firebase-helpers","dist-tags":{"latest":"1.1.0"},"versions":{"1.1.0":{"name":"@emjimadhu/firebase-helpers","version":"1.1.0","description":"A Tiny Helper utility for Firebase.","main":"index.js","scripts":{"push":"bash git.sh"},"repository":{"type":"git","url":"git+https://github.com/emjimadhu/firebase-helpers.git"},"keywords":["firebase","helpers","js"],"author":{"name":"Em Ji Madhu"},"license":"MIT","bugs":{"url":"https://github.com/emjimadhu/firebase-helpers/issues"},"homepage":"https://github.com/emjimadhu/firebase-helpers#readme","gitHead":"89d0ded138ab19f08b4f39a3838bae169cff2687","_id":"@emjimadhu/firebase-helpers@1.1.0","_npmVersion":"6.4.1","_nodeVersion":"10.11.0","_npmUser":{"name":"emjimadhu","email":"emjimadhu@gmail.com"},"dist":{"integrity":"sha512-89ybGWTGrSHKaveREVriu9xCg1PAaRseplQSbX8GCNL1fe/8UWJi9W2hRT2Tg84tmUHc85B6ICvJO6Q1g1mzsw==","shasum":"1a3aa582f764712e8dd6cd81305c0ef3ccc7eecc","tarball":"https://registry.npmjs.org/@emjimadhu/firebase-helpers/-/firebase-helpers-1.1.0.tgz","fileCount":4,"unpackedSize":10850,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbvlu5CRA9TVsSAnZWagAA6XsP/3aML7NibCaB7abfsQra\n0GqUsa2JDYSHyz0aaGxNbHzRxTCyJ3KGpuDMhMdlNtoEI2qDamy0GCA6Fqm5\niw7SMoEVs6qwV6y0P6VBlBtyycK15nX+qcEFK3PkLzXmRqRV/zb81ZQXVRSG\nxFrejcm/HVm/hT+cK7F6VXKROiJFMnnYraeV9r4Uo6vJgux0pBfwHEWI4nTm\n7d6/UtECxwtdf2hbz+ybF+PdrcVSDsekdY+FGTgTn07Khpcdlx6tAfLEVtJk\nDfLUwsy5bfAamLkihjCaTfIDDrlhpApLA987RFc93DhwrwaKxavpkbl4hD6O\n3zmJGGAlE5ibwT/dQf1Ll6lZjDG5MFFxuiorricfy/mEM83wunKMvL+meGK8\nY+DIVCpRAKDrjn+8A9D73HSljGY4t5FLfweMs2nBBdAnrrii+zDgdIuvCobO\nHOvHJvTiQ6Z3YNM2st1KEYmiyC8f+d3bnJjYWvCjA+Yf+w88eZAwTFb9wf3K\nooTwLnQaVYab5XnfZ51JcHcBpZOmk0AenB05biHgC9RKJokwToAGRz66MMHX\nCVnmSNA49f6PcAwngi6fhuukEFDTtQDRewSqdH7FbCFlFJ/lJAxWIAisxkkM\ny+oUKJWAoTRjqb1yxzXMEn2zfq5I5FlsQnpQFv2/erirYCMBpvw8ST5WxFZl\nYiYP\r\n=fWor\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVKNQYRC6OxfdoGyykyc1ol82h5Q+uXAohUrecdBRs2AIhAJJ0c1rxBSKsciuXx8642iDwAABVIjROF5YnY9fzapnj"}]},"maintainers":[{"name":"emjimadhu","email":"emjimadhu@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/firebase-helpers_1.1.0_1539201976317_0.22733539019502724"},"_hasShrinkwrap":false}},"time":{"created":"2018-10-10T20:06:16.151Z","1.1.0":"2018-10-10T20:06:16.401Z","modified":"2022-04-05T07:33:54.411Z"},"maintainers":[{"name":"emjimadhu","email":"emjimadhu@gmail.com"}],"description":"A Tiny Helper utility for Firebase.","homepage":"https://github.com/emjimadhu/firebase-helpers#readme","keywords":["firebase","helpers","js"],"repository":{"type":"git","url":"git+https://github.com/emjimadhu/firebase-helpers.git"},"author":{"name":"Em Ji Madhu"},"bugs":{"url":"https://github.com/emjimadhu/firebase-helpers/issues"},"license":"MIT","readme":"### FIREBASE-HELPERS\n\nA Tiny Helper utility to use Firebase.\n\n## Installation\n\n  `npm install @emjimadhu/firebase-helpers`\n\n## Usuage\n\n```javascript\n  import Firebase from '@emjimadhu/firebase-helpers'\n\n  // Intialize Firebase by passing Firebase Config Object\n  Firebase.init(options)\n\n  // Staet Using it\n  const dataArr = Firebase.read('some-awesome-collection')\n```\n\n## Table of Contents (APIs)\n\n-   [Firebase][1]\n    -   [init][2]\n        -   [Parameters][3]\n    -   [read][4]\n        -   [Parameters][5]\n    -   [add][6]\n        -   [Parameters][7]\n    -   [login][8]\n        -   [Parameters][9]\n    -   [register][10]\n        -   [Parameters][11]\n    -   [logout][12]\n    -   [socialLogin][13]\n        -   [Parameters][14]\n    -   [currentUser][15]\n    -   [sendEmailVerification][16]\n    -   [resetpassword][17]\n        -   [Parameters][18]\n\n## Firebase\n\nClass Firebase Object.\n\n### init\n\ninitializes Firebase Instance.\n\n#### Parameters\n\n-   `options` **[object][19]** Firebase Config Options.\n\nReturns **void** No Return.\n\n### read\n\nRead Collect Datas\n\n#### Parameters\n\n-   `collectionName` **[string][20]** Name of the Firestore Collection to read\n\nReturns **[array][21]** Array of Datas.\n\n### add\n\nAdd Data to Firestore Collection\n\n#### Parameters\n\n-   `collectionName` **[string][20]** Name of the Firestore Collection.\n-   `data` **[object][19]** Data to stored.\n\nReturns **[object][19]** Returns data reference\n\n### login\n\nLogin using Email And Password to Firebase\n\n#### Parameters\n\n-   `options` **[object][19]** Object contiaining Email And Password Keys.\n    -   `options.email`  \n    -   `options.password`  \n\nReturns **[object][19]** Returns User Object\n\n### register\n\nRegister using Email And Password to Firebase\n\n#### Parameters\n\n-   `options` **[object][19]** Object contiaining Email And Password Keys.\n    -   `options.email`  \n    -   `options.password`  \n\nReturns **[object][19]** Returns User Object\n\n### logout\n\nLogsout from Firebase.\n\nReturns **void** Returns undefined\n\n### socialLogin\n\nFirebase Social Authentications\n\n#### Parameters\n\n-   `socialName` **[string][20]** Name of the Social Authtication to Connect (ex: google, facebook, twitter and github)\n\nReturns **[object][19]** Returns User Object\n\n### currentUser\n\nGet Currently Logged In User.\n\nReturns **[object][19]** Returns User Object\n\n### sendEmailVerification\n\nSend Email Verification\n\nReturns **[object][19]** Returns Status Information\n\n### resetpassword\n\nReset Password\n\n#### Parameters\n\n-   `email` **[string][20]** An Email address to send Reset password link\n\nReturns **[object][19]** Returns status\n\n[1]: #firebase\n\n[2]: #init\n\n[3]: #parameters\n\n[4]: #read\n\n[5]: #parameters-1\n\n[6]: #add\n\n[7]: #parameters-2\n\n[8]: #login\n\n[9]: #parameters-3\n\n[10]: #register\n\n[11]: #parameters-4\n\n[12]: #logout\n\n[13]: #sociallogin\n\n[14]: #parameters-5\n\n[15]: #currentuser\n\n[16]: #sendemailverification\n\n[17]: #resetpassword\n\n[18]: #parameters-6\n\n[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object\n\n[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String\n\n[21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array\n","readmeFilename":"README.md"}