deku-prop-types-immutable

deku-prop-types-immutable

Immutable prop type validation for Deku components

Install

npm install --save deku-prop-types-immutable

Usage

Note: These Prop Type Validators are meant to be used alongside deku-prop-types

function-component.jsx

import {element} from 'deku'
import ImmutablePropTypes from 'deku-prop-types-immutable'
import {PropTypes, validate} from 'deku-prop-types'

const Counter = ({props}) => <div>{props.count}</div>
Count.propTypes = {
  count: PropTypes.number.isRequired,
  config: ImmutablePropTypes.Map
}

export default validate(Counter)

object-component.jsx

import {element} from 'deku'
import ImmutablePropTypes from 'deku-prop-types-immutable'
import {PropTypes, validate} from 'deku-prop-types'

const Counter = {
  propTypes: {
    count: PropTypes.number.isRequired,
    config: ImmutablePropTypes.Map
  },
  render({props}) {
    return <div>{props.count}</div>
  }
}

export default validate(Counter)

Supported types

ImmutablePropTypes.Iterable

Validate prop is an Immutable.Iterable

ImmutablePropTypes.List

Validate prop is an Immutable.List

ImmutablePropTypes.Map

Validate prop is an Immutable.Map

ImmutablePropTypes.OrderedMap

Validate prop is an Immutable.OrderedMap

ImmutablePropTypes.OrderedSet

Validate prop is an Immutable.OrderedSet

ImmutablePropTypes.Record

Validate prop is an Immutable.Record

ImmutablePropTypes.Set

Validate prop is an Immutable.Set

ImmutablePropTypes.Seq

Validate prop is an Immutable.Seq

ImmutablePropTypes.Stack

Validate prop is an Immutable.Stack

License

MIT © Dustin Specker