Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cartant/firebase-key
Firebase key utility and encoding/decoding functions
https://github.com/cartant/firebase-key
firebase key utilities
Last synced: 19 days ago
JSON representation
Firebase key utility and encoding/decoding functions
- Host: GitHub
- URL: https://github.com/cartant/firebase-key
- Owner: cartant
- License: mit
- Created: 2017-04-23T23:30:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T10:40:06.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T21:47:03.604Z (10 months ago)
- Topics: firebase, key, utilities
- Language: TypeScript
- Homepage: https://cartant.github.io/firebase-key/
- Size: 826 KB
- Stars: 39
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# firebase-key
[](https://github.com/cartant/firebase-key/blob/master/LICENSE)
[](https://www.npmjs.com/package/firebase-key)
[](https://npmjs.org/package/firebase-key)
[](https://app.circleci.com/pipelines/github/cartant)
[](https://david-dm.org/cartant/firebase-key)
[](https://david-dm.org/cartant/firebase-key#info=devDependencies)
[](https://david-dm.org/cartant/firebase-key#info=peerDependencies)
[](https://greenkeeper.io/)
### What is it?
`firebase-key` is a library of utility functions for manipulating, encoding and decoding Firebase keys.
### Why might you need it?
You might find `firebase-key` useful if you need to do any of the following:
* Convert a Firebase push key/ID to a time.
* Query push keys/IDs based on time.
* Page through push keys/IDs as efficiently as possible.
* Store illegal characters in Firebase keys.
* Encode integers as strings that sort numerically.
## Install
Install the package using NPM:
```
npm install firebase-key --save
```
And import the functions for use with TypeScript or ES2015:
```js
import { key } from "firebase-key";
console.log(key());
```
Or `require` the module for use with Node or a CommonJS bundler:
```js
const firebaseKey = require("firebase-key");
console.log(firebaseKey.key());
```
Or include the UMD bundle for use as a `script`:
```html
console.log(firebaseKey.key());
```
## API
* [key](#key)
* [date](#date-milliseconds)
* [milliseconds](#date-milliseconds)
* [increment](#increment-decrement)
* [decrement](#increment-decrement)
* [encode](#encode-decode)
* [decode](#encode-decode)
* [encodeLexicographic](#encode-decode-lexicographic)
* [decodeLexicographic](#encode-decode-lexicographic)
### key
```ts
function key(
timestamp: number | Date = Date.now(),
as: "max" | "min" | "random" = "random"
): string
```
This function is based on the Firebase push key/ID generator implemented in [this gist][gist].
If called with no arguments, it generates a Firebase push key/ID using the current time. If a timestamp is specified, it is used in the generation of the key.
By default, the timestamp is combined with random data. If `as` is specified as either `max` or `min`, random data is not used and the generated key will sort either after (for `max`) or before (for `min`) any other keys that that have the same timestamp, but have random data.
### date/milliseconds
```ts
function date(key: string): Date
function milliseconds(key: string): number
```
These functions return the timestamp of a push key/ID, either as a `Date` or as the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC.
### increment/decrement
```ts
function increment(key: string): string
function decrement(key: string): string
```
These functions return a push key/ID that has been incremented or decremented to the next consecutive push key/ID and can be useful when paging through the Firebase database.
### encode/decode
```ts
function encode(text: string): string
function decode(key: string): string
```
These functions encode and decode keys, replacing illegal characters with safe, encoded characters.
`!` is used as an escape character - rather than `%` - for compatibility with the REST API and with the Firebase management console.
### encodeLexicographic/decodeLexicographic
```ts
function encodeLexicographic(value: number): string
function decodeLexicographic(key: string): number
```
These functions encode and decode integer values (both positive and negative) as strings that have a lexicographic ordering that is identical to the numeric ordering. They are based upon an implementation used in [Firepad][firepad].
[gist]: https://gist.github.com/mikelehen/3596a30bd69384624c11
[firepad]: https://github.com/firebase/firepad/blob/v1.4.0/lib/firebase-adapter.js#L375-L403