# immutable-prop-types
> PropType validators that work with Immutable.js
Latest version **0.0.3** (published 2018-06-16) · MIT license · 0 weekly downloads
## Install
```sh
npm install immutable-prop-types
pnpm add immutable-prop-types
yarn add immutable-prop-types
bun add immutable-prop-types
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.3 |
| Published | 2018-06-16 |
| First published | 2018-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 18.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Zach Toben |
| Maintainers | ztoben |
| Keywords | react, immutable-js, immutable, immutablejs, proptype |
## Links
- npm: https://www.npmjs.com/package/immutable-prop-types
- Repository: https://github.com/ztoben/immutable-prop-types
- Issues: https://github.com/ztoben/immutable-prop-types/issues
- npm.io page: https://npm.io/package/immutable-prop-types
## Dependencies (1)
- [invariant](https://npm.io/package/invariant.md) 2.2.4
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 0.0.3 (latest) — 2018-06-16
- 0.0.2 (beta) — 2018-06-16
- 0.0.1 — 2018-06-16
## README
# immutable-prop-types
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.org/package/immutable-prop-types)
[](https://travis-ci.org/ztoben/immutable-prop-types)
[](https://greenkeeper.io/)
PropType validators that work with Immutable.js. Forked from [react-immutable-proptypes](https://github.com/HurricaneJames/react-immutable-proptypes).
## About
Usage is simple, they work with and like any `PropType.*` validator.
```js
import PropTypes from 'prop-types';
import ImmutablePropTypes from 'immutable-prop-types';
class MyReactComponent extends React.Component {
// ...
}
MyReactComponent.propTypes = {
myRequiredImmutableList: ImmutablePropTypes.listOf(
ImmutablePropTypes.contains({
someNumberProp: PropTypes.number.isRequired
})
).isRequired
};
```
Convenience helpers for "primitive" Immutable.js objects:
```js
propTypes: {
oldListTypeChecker: PropTypes.instanceOf(Immutable.List),
anotherWay: ImmutablePropTypes.list,
requiredList: ImmutablePropTypes.list.isRequired,
mapsToo: ImmutablePropTypes.map,
evenIterable: ImmutablePropTypes.iterable
}
```
## Installation
Installing via [npmjs](https://www.npmjs.com/package/immutable-prop-types)
```bash
npm install --save immutable-prop-types
```
## API
Immutable prop types has:
* Primitive Types
```js
ImmutablePropTypes.list // Immutable.List.isList
ImmutablePropTypes.map // Immutable.Map.isMap
ImmutablePropTypes.orderedMap // Immutable.OrderedMap.isOrderedMap
ImmutablePropTypes.set // Immutable.Set.isSet
ImmutablePropTypes.orderedSet // Immutable.OrderedSet.isOrderedSet
ImmutablePropTypes.stack // Immutable.Stack.isStack
ImmutablePropTypes.seq // Immutable.Seq.isSeq
ImmutablePropTypes.iterable // Immutable.Iterable.isIterable
ImmutablePropTypes.record // instanceof Record
ImmutablePropTypes.contains // Immutable.Iterable.isIterable - contains(shape)
ImmutablePropTypes.mapContains // Immutable.Map.isMap - contains(shape)
```
* `ImmutablePropTypes.contains` (formerly `shape`) is based on `PropTypes.shape` and will try to work with any `Immutable.Iterable`. In my usage it is the most used validator, as I'm often trying to validate that a map has certain properties with certain values.
```es6
// ...
aMap: ImmutablePropTypes.contains({
aList: ImmutablePropTypes.contains({
0: PropTypes.number,
1: PropTypes.string,
2: PropTypes.number.isRequired,
}).isRequired,
})
// ...
```
* `ImmutablePropTypes.listOf` is based on `PropTypes.array` and is specific to `Immutable.List`.
* `ImmutablePropTypes.mapOf` allows you to control both map values and keys (in Immutable.Map, keys could be _anything_ including another Immutable collections). It accepts two arguments - first one for values, second one for keys (optional). If you are interested in validation of keys only, just pass `PropTypes.any` as the first argument.
```es6
// ...
aMap: ImmutablePropTypes.mapOf(
PropTypes.any, // validation for values
ImmutablePropTypes.mapContains({ // validation for keys
a: PropTypes.number.isRequired,
b: PropTypes.string
})
)
// ...
const aMap = Immutable.Map([
[Immutable.Map({a: 1, b: '2'}), 'foo'],
[Immutable.Map({a: 3}), [1, '2', 3]]
]);
```
* `ImmutablePropTypes.orderedMapOf` is basically the same as `mapOf`, but it is specific to `Immutable.OrderedMap`.
* `ImmutablePropTypes.orderedSetOf` is basically the same as `listOf`, but it is specific to `Immutable.OrderedSet`.
* `ImmutablePropTypes.stackOf` is basically the same as `listOf`, but it is specific to `Immutable.Stack`.
* `ImmutablePropTypes.iterableOf` is the generic form of listOf/mapOf. It is useful when there is no need to validate anything other than Immutable.js compatible (ie. `Immutable.Iterable`). Continue to use `listOf` and/or `mapOf` when you know the type.
* `ImmutablePropTypes.recordOf` is like `contains`, except it operates on Record properties.
```js
// ...
aRecord: ImmutablePropTypes.recordOf({
keyA: PropTypes.string,
keyB: ImmutablePropTypes.list.isRequired
})
// ...
```
* `ImmutablePropTypes.mapContains` is based on `PropTypes.shape` and will only work with `Immutable.Map`.
```es6
// ...
aMap: ImmutablePropTypes.mapContains({
aList: ImmutablePropTypes.list.isRequired,
})
// ...
```
These two validators cover the output of `Immutable.fromJS` on standard JSON data sources.
---
_Source: https://npm.io/package/immutable-prop-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._