Documentation tool: toMarkdown(json: JSON) => string module

[gcanti]

Source

import React from 'react'
import { props, t } from 'tcomb-react'
import User from './User'

/**
 * Component description here
 * name and surname must be both nil or both specified
 * @param name - name description
 * @param surname - surname description
 */

const Props = t.refinement(t.struct({
  name: t.maybe(User.meta.props.name),
  surname: t.maybe(User.meta.props.surname)
}), (x) => t.Nil.is(x.name) === t.Nil.is(x.surname))

@props(Props)
export default class Card extends React.Component {

  static defaultProps = {
    name: 'Giulio',
    surname: 'Canti'
  }

  render() {
    return (
      <div>
        <p>{this.props.name}</p>
        <p>{this.props.surname}</p>
      </div>
    )
  }
}

Usage

var parse = require('tcomb-react/lib/parse');
var toMarkdown = require('tcomb-react/lib/toMarkdown');
var json = parse('../components/Card.js');
console.log(toMarkdown(json));

Output

# Card

Component description here
name and surname must be both nil or both specified

**Props**

- `name: String` (optional, default: `"Giulio"`) name description
- `surname: String` (optional, default: `"Canti"`) surname description

Card

Component description here
name and surname must be both nil or both specified

Props

• name: String (optional, default: "Giulio") name description
• surname: String (optional, default: "Canti") surname description