# rtc-validator

> Validation routines for WebRTC

Latest version **1.2.3** (published 2021-05-28) · Apache 2.0 license · 0 weekly downloads

## Install

```sh
npm install rtc-validator
pnpm add rtc-validator
yarn add rtc-validator
bun add rtc-validator
```

## 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.2.3 |
| Published | 2021-05-28 |
| First published | 2014-08-19 |
| Weekly downloads | 0 |
| License | Apache 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Damon Oehlman |
| Maintainers | nathanoehlman, damonoehlman |
| Keywords | webrtc, rtc.io, validation |

## Links

- npm: https://www.npmjs.com/package/rtc-validator
- Repository: https://github.com/rtc-io/rtc-validator
- Issues: https://github.com/rtc-io/rtc-validator/issues
- npm.io page: https://npm.io/package/rtc-validator

## Dependencies (2)

- [cog](https://npm.io/package/cog.md) ^1.0.0
- [reu](https://npm.io/package/reu.md) ^1.1.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.2.3 (latest) — 2021-05-28
- 1.2.2 — 2015-04-10
- 1.2.1 — 2015-03-13
- 1.2.0 — 2014-08-19
- 1.1.0 — 2014-08-19
- 1.0.0 — 2014-08-19

## README

# rtc-validator

This is a collection of validation routines for validating different apsects
of WebRTC.


[![NPM](https://nodei.co/npm/rtc-validator.png)](https://nodei.co/npm/rtc-validator/)

[![Build Status](https://img.shields.io/travis/rtc-io/rtc-validator.svg?branch=master)](https://travis-ci.org/rtc-io/rtc-validator) [![unstable](https://img.shields.io/badge/stability-unstable-yellowgreen.svg)](https://github.com/dominictarr/stability#unstable) 

## Usage

All of the validator modules in this package export a single function which
uses the following function signature:

```
fn(topic) -> []
```

Whereas a normal validator function might return a value of `true` for no
problems, these validator functions return an array of errors encountered
while validating the `topic`.

This provides the ability to use the validators in the following way:

```
TODO: include example
```

## Reference

### `validator.ok(errors)`

Return whether the result of a validator passes the "ok" test, i.e. no
errors were returned.

### `rtc-validator/candidate`

Validate that an `RTCIceCandidate` (or plain old object with data, sdpMid,
etc attributes) is a valid ice candidate.

Specs reviewed as part of the validation implementation:

- <http://tools.ietf.org/html/draft-ietf-mmusic-ice-sip-sdp-03#section-8.1>
- <http://tools.ietf.org/html/rfc5245>

## License(s)

### Apache 2.0

Copyright 2014 National ICT Australia Limited (NICTA)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

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