# firebase-server-value

> Create, detect, and validate Firebase.ServerValue

Latest version **1.0.2** (published 2015-06-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install firebase-server-value
pnpm add firebase-server-value
yarn add firebase-server-value
bun add firebase-server-value
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2015-06-18 |
| First published | 2015-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | firebase, server, value |

## Links

- npm: https://www.npmjs.com/package/firebase-server-value
- Repository: https://github.com/bendrucker/firebase-server-value
- Homepage: https://github.com/bendrucker/firebase-server-value#readme
- Issues: https://github.com/bendrucker/firebase-server-value/issues
- npm.io page: https://npm.io/package/firebase-server-value

## Dependencies (1)

- [is-object](https://npm.io/package/is-object.md) ~1.0.1

## Recent versions

- 1.0.2 (latest) — 2015-06-18
- 1.0.1 — 2015-06-18
- 1.0.0 — 2015-05-15

## README

# firebase-server-value [![Build Status](https://travis-ci.org/bendrucker/firebase-server-value.svg?branch=master)](https://travis-ci.org/bendrucker/firebase-server-value)

> Create, detect, and validate [Firebase.ServerValue](https://www.firebase.com/docs/web/api/servervalue/)


## Install

```
$ npm install --save firebase-server-value
```


## Usage

```js
var firebaseServerValue = require('firebase-server-value')

firebaseServerValue.parse({
  '.sv': 'timestamp'
}) // => current timestamp
```

## API

#### `sv.ServerValue`

An object deeply equal to `Firebase.ServerValue`

#### `sv.is(value)`

Checks whether a given value is a valid `ServerValue` placeholder.

##### value

*Required*  
Type: `any`


#### `sv.parse(value)`

Parse a `ServerValue` placeholder into its actual value.

##### value

*Required*  
Type: `object`

An error will be thrown if value is not a valid `ServerValue` according to `sv.is`.

#### `sv.values`

An object with keys corresponding to the valid `'.sv'` placeholders (currently just `'timestamp'`) and the function used by `sv.parse` to generate a result as the values. The functions are called with no arguments. They can be overridden to modify the conversion of placeholders to true values.


## License

MIT © [Ben Drucker](http://bendrucker.me)

---
_Source: https://npm.io/package/firebase-server-value · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._