https://github.com/fabricelements/shared-helpers
Helpers for Firebase projects
https://github.com/fabricelements/shared-helpers
firebase firestore typescript
Last synced: 3 months ago
JSON representation
Helpers for Firebase projects
- Host: GitHub
- URL: https://github.com/fabricelements/shared-helpers
- Owner: FabricElements
- License: bsd-3-clause
- Created: 2019-04-11T20:22:20.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-02-25T14:42:53.000Z (over 2 years ago)
- Last Synced: 2024-02-25T15:45:22.636Z (over 2 years ago)
- Topics: firebase, firestore, typescript
- Language: TypeScript
- Homepage:
- Size: 2.76 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.MD
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# FabricElements Shared Helpers
Use `@fabricelements/shared-helpers` on Firebase projects.
------
## Installation
From NPM
```shell
$ npm i @fabricelements/shared-helpers --save
```
or from GitHub
```shell
$ npm i github:FabricElements/shared-helpers --save
```
## Examples
### Basic usage
Import only what you need
```js
import {firestore, pubSubEvent} from "@fabricelements/shared-helpers";
```
Or import everything
```js
import * as sharedHelpers from "@fabricelements/shared-helpers";
```
## Available functions
### [apiRequest](src/api-request.ts)
Call firebase project base API
### [backup](src/backup.ts)
Custom backup from Firestore to BigQuery
### [checkNumber](src/check-number.ts)
Check if number is valid and format
### [cleaner](src/cleaner.ts)
Big Query Clean Database
### [firestore](src/firestoreHelper.ts)
Google Cloud Firestore helpers
### [global](src/global.ts)
Basic and reusable helpers
### [hashId](src/hash-id.ts)
Generate randomDomain hash id with 4 characters or more
### [pubSubEvent](src/pubsub-event.ts)
Google cloud Pub/Sub event
### [replaceMessageText](src/replace-message-text.ts)
Replace message text with custom keys
### [specialCharToRegular](src/special-char-to-regular.ts)
Replace special character to regular gsm character
### [status](src/status.ts)
Update Status Collection with Errors
## Contributing
Please check [CONTRIBUTING](CONTRIBUTING.md).
## License
Released under the [BSD 3-Clause License](LICENSE.md).