{"_id":"tcomb-doc","_rev":"14-ab32eb2e616f0d66c4bbccfd27b5f23c","name":"tcomb-doc","description":"Documentation tool for tcomb","dist-tags":{"latest":"0.5.2"},"versions":{"0.2.1":{"name":"tcomb-doc","version":"0.2.1","description":"Documentation tool for tcomb","main":"index.js","scripts":{},"repository":{"type":"git","url":"https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","dependencies":{"tcomb":"~0.2.0"},"tags":["tcomb","documentation","tool"],"gitHead":"5aae7a29a266a70e3cff97dfe8de733b4f9d3aae","_id":"tcomb-doc@0.2.1","_shasum":"a5308dc1b7a11f50d874ae090df90b91d921c86b","_from":".","_npmVersion":"2.0.0-beta.0","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"a5308dc1b7a11f50d874ae090df90b91d921c86b","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.2.1.tgz","integrity":"sha512-vryKQelLli17g07LU7as7PHab0Efy9AWk142Q11e8SQQafYQSr6y0JddD/Y6pkwyfEGJS4hWgOxejrMk+SmXzw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCkwS8HOd4glZbLaEUnDVSbmwAhoNmCDeQAJj2w6JBD+gIgCMaMLCVgdUjaN5h92sr3zRo3juTuH8PWFeiIApcSQ/k="}]}},"0.2.2":{"name":"tcomb-doc","version":"0.2.2","description":"Documentation tool for Domain Driven Design","main":"index.js","scripts":{},"repository":{"type":"git","url":"https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","dependencies":{"tcomb":"~0.2.0"},"tags":["tcomb","documentation","tool"],"gitHead":"cbb170b8f1353b7ef99258623ccfce19dcf6c6ef","_id":"tcomb-doc@0.2.2","_shasum":"3085ab1c004d09b8c27ec2be755b079f3fbfd671","_from":".","_npmVersion":"2.0.0-beta.0","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"3085ab1c004d09b8c27ec2be755b079f3fbfd671","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.2.2.tgz","integrity":"sha512-jxD3dhyQlDMR2w0+vAhaarqSKT+1TrEW0ArYQReTOMstFwKge1Rskxu1LTSuTGZ4DCn5Y4f4avBWQSVKivJ/ww==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDMAB+Ieg5xG5rRkrjavwy5Dj4BH4pAKN9dKdR7A81qfAIgAp9MFfsi6CiLY7r+cfN2HiilArpQFSpc2HYWMGb6itg="}]}},"0.2.3":{"name":"tcomb-doc","version":"0.2.3","description":"Documentation tool for Domain Driven Design","main":"index.js","scripts":{"playground":"watchify playground/playground.src.js -o playground/playground.js -v"},"repository":{"type":"git","url":"https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","devDependencies":{"tcomb-form":"^0.1.5","react":"^0.12.0","marked":"~0.3.2"},"dependencies":{"tcomb":"^0.3.1","escodegen":"~1.4.1","esprima":"~1.2.2","estraverse":"~1.5.1"},"tags":["tcomb","documentation","tool"],"keywords":["tcomb","documentation","tool"],"gitHead":"9633a15a96dd1a7f4d550193051522d83ac3b409","_id":"tcomb-doc@0.2.3","_shasum":"db28e50927e776bd5de54023addf464841090378","_from":".","_npmVersion":"2.0.0-beta.0","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"db28e50927e776bd5de54023addf464841090378","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.2.3.tgz","integrity":"sha512-Py4eDvbnAk4mPh3dVPv3aC/0xOYb4jRqORhGaCQ93crRlta1oXQTAxs8+tB7wHxpajrOZiws4iSyShCttRH4Bg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDfAVdyNg1FHdh83w0txb3Np3VHElgDbJC0d1hZM1QUPgIhAKd+ZUXKb1lf5pYgI4Ks0jzwN9gEeyN63V5DP0pQGh97"}]}},"0.3.0":{"name":"tcomb-doc","version":"0.3.0","description":"Documentation tool for tcomb","main":"index.js","scripts":{"playground":"watchify playground/playground.src.js -o playground/playground.js -v"},"repository":{"type":"git","url":"https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","devDependencies":{"marked":"^0.3.3","react":"^0.13.1","tcomb-form":"^0.4.4"},"dependencies":{"esprima":"^2.1.0","estraverse":"^3.1.0","tcomb":"^1.0.0"},"tags":["tcomb","documentation","tool"],"keywords":["tcomb","documentation","tool"],"gitHead":"6899ff4487b75e57c96143da8ae2af5817a2347f","_id":"tcomb-doc@0.3.0","_shasum":"8636a8d11876f179c9e1d42890c0189a1a6c32f7","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"8636a8d11876f179c9e1d42890c0189a1a6c32f7","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.3.0.tgz","integrity":"sha512-6RBotd5zgqufei8PjteGJgRh/5mU0sbwfIHtY2tCkd4Z6v8JlM0t7NGllhwtnjgv5LjjK4fvuplLZt/0spl7IA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVIG5/qfkgtOgfaZatIWkAy53qQ4AyF+K6ylhIylVj6AIhAJYaOuLA6NMD0tlsPFUiPLexzPduZGkTidy1hybFIunt"}]}},"0.4.0":{"name":"tcomb-doc","version":"0.4.0","description":"Documentation tool for tcomb","main":"lib/index.js","files":["lib"],"scripts":{"lint":"eslint lib test","test":"karma start","test:node":"node test"},"dependencies":{"tcomb":"^2.5.2"},"devDependencies":{"eslint":"1.10.3","isparta-loader":"1.0.0","karma":"0.13.9","karma-chrome-launcher":"0.2.2","karma-coverage":"0.5.3","karma-firefox-launcher":"0.1.7","karma-tap":"1.0.3","karma-webpack":"1.7.0","tape":"4.4.0","webpack":"1.12.9"},"repository":{"type":"git","url":"git+https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","tags":["tcomb","documentation","tool"],"keywords":["tcomb","documentation","tool"],"gitHead":"496c88c0176ca1cd3190ba87acb22e7acfbdc2b2","_id":"tcomb-doc@0.4.0","_shasum":"9b12cb20dc0ea09f0229f9de8116e329b4fc7976","_from":".","_npmVersion":"2.9.0","_nodeVersion":"0.12.2","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"9b12cb20dc0ea09f0229f9de8116e329b4fc7976","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.4.0.tgz","integrity":"sha512-KQfQp4tYN/Z7aCHR3LxZjQYCFKKHqj+SPkhWdQSvtXApx7xEzAY2xkYUiNURueENbMu7plt4abBIVLwMrea+/Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD/c/KwPxs2Tcl7nyqoEG1Hhqs4HmV51YGPcOYacl2C3AIhAJ4AcMtAFYDJqnlzEX5E9AqkUmGpFCZ0mynJ/1G2d5p0"}]}},"0.5.0":{"name":"tcomb-doc","version":"0.5.0","description":"Documentation tool for tcomb","main":"lib/index.js","files":["lib"],"scripts":{"lint":"eslint lib test","test":"karma start","test:node":"node test"},"dependencies":{"tcomb":"^3.0.0"},"devDependencies":{"eslint":"1.10.3","isparta-loader":"1.0.0","karma":"0.13.9","karma-chrome-launcher":"0.2.2","karma-coverage":"0.5.3","karma-firefox-launcher":"0.1.7","karma-tap":"1.0.3","karma-webpack":"1.7.0","tape":"4.4.0","webpack":"1.12.9"},"repository":{"type":"git","url":"git+https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","tags":["tcomb","documentation","tool"],"keywords":["tcomb","documentation","tool"],"gitHead":"f24e210847deae1600128439ce36aaa9a25d1b49","_id":"tcomb-doc@0.5.0","_shasum":"0623ac73f9b2b977e4f95ed896ed325f299f5802","_from":".","_npmVersion":"3.3.12","_nodeVersion":"5.5.0","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"0623ac73f9b2b977e4f95ed896ed325f299f5802","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.5.0.tgz","integrity":"sha512-FjDxjE67VtIg4LHZ9e427XXl7yQXNsyDjbkKWcg32Qn18pLwPJnFC19WB1bPPbOeTX+BegLhTmmFSy8oQ/oe6A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDfzL7JXRpEWwUbiNhnQ3l5nWphCWRiWvPphimf7kC0iAIgdn1fACQOdUKT0VA4w6o7vEiwZ1TKNhqu7UwbimOhxWg="}]},"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/tcomb-doc-0.5.0.tgz_1457352515188_0.7828043312765658"}},"0.5.1":{"name":"tcomb-doc","version":"0.5.1","description":"Documentation tool for tcomb","main":"lib/index.js","files":["lib"],"scripts":{"lint":"eslint lib test","test":"karma start","test:node":"node test"},"dependencies":{"tcomb":"^3.0.0"},"devDependencies":{"eslint":"1.10.3","isparta-loader":"1.0.0","karma":"0.13.9","karma-chrome-launcher":"0.2.2","karma-coverage":"0.5.3","karma-firefox-launcher":"0.1.7","karma-tap":"1.0.3","karma-webpack":"1.7.0","tape":"4.4.0","webpack":"1.12.9"},"repository":{"type":"git","url":"git+https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","tags":["tcomb","documentation","tool"],"keywords":["tcomb","documentation","tool"],"gitHead":"7efe74bb54b82812aa750b0b53f84b6467442caf","_id":"tcomb-doc@0.5.1","_shasum":"b04b621e837e98227ddf40356fdc5f59b4d62aa7","_from":".","_npmVersion":"3.3.12","_nodeVersion":"5.5.0","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"b04b621e837e98227ddf40356fdc5f59b4d62aa7","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.5.1.tgz","integrity":"sha512-lwYamIzz5iBd4+K56gH9C8C3ZqLPtoiPSEAOphATa6xuTWqCAu/HBL29PQtlv2UAZCnd8ZFsGMye9pmkVM98hQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDfoCQGDl7qdkNNsJV0t5GmnocxP0fvCykpbLlm68uSKAIhAInqtUqKcD8JW84lBc3YS0enzrP4lJwyrS6v/fy7x/NO"}]},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/tcomb-doc-0.5.1.tgz_1463295539454_0.6219826028682292"}},"0.5.2":{"name":"tcomb-doc","version":"0.5.2","description":"Documentation tool for tcomb","main":"lib/index.js","files":["lib"],"scripts":{"lint":"eslint lib test","test":"karma start","test:node":"node test"},"dependencies":{"tcomb":"^3.0.0"},"devDependencies":{"eslint":"1.10.3","isparta-loader":"1.0.0","karma":"0.13.9","karma-chrome-launcher":"0.2.2","karma-coverage":"0.5.3","karma-firefox-launcher":"0.1.7","karma-tap":"1.0.3","karma-webpack":"1.7.0","tape":"4.4.0","webpack":"1.12.9"},"repository":{"type":"git","url":"git+https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"homepage":"https://github.com/gcanti/tcomb-doc","tags":["tcomb","documentation","tool"],"keywords":["tcomb","documentation","tool"],"gitHead":"5546373739697d1d9e7c8940e5d60a76dd7efdc0","_id":"tcomb-doc@0.5.2","_shasum":"d58a653a3007e3649127864010c558a7bf666d1e","_from":".","_npmVersion":"3.3.12","_nodeVersion":"5.5.0","_npmUser":{"name":"gcanti","email":"giulio.canti@gmail.com"},"maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"dist":{"shasum":"d58a653a3007e3649127864010c558a7bf666d1e","tarball":"https://registry.npmjs.org/tcomb-doc/-/tcomb-doc-0.5.2.tgz","integrity":"sha512-o8b4icvjW9nveIWIEyH/NrJIPhiQUHFjXlWJnRO5iEWw0m+k8vB0JzgyDLBk9xYZXylLK5yXUTbUv1FVFa2EAg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCjoMFtcqPFTwWHL4qCisvg7MOzYbEPXiIDNt0enXiN/gIgI2ui8QFosYiANc7Yh8J1kKwvZHxKkmZLUFzl9c1LbF0="}]},"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/tcomb-doc-0.5.2.tgz_1464942517851_0.6585254033561796"}}},"readme":"Documentation tool for [tcomb](https://github.com/gcanti/tcomb)\n\n# API\n\n## toObject\n\n**Signature**\n\n```js\ntoObject(types: TcombType | Array<TcombType>) => JSON blob / JavaScript object\n```\n\n**Example**\n\n```js\nimport t from 'tcomb'\nimport { toObject } from 'tcomb-doc'\n\nconst Person = t.struct({\n  name: t.String,\n  age: t.maybe(t.Number)\n}, 'User')\n\nconsole.log(JSON.stringify(toObject(Person), null, 2))\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"struct\",\n  \"name\": \"User\",\n  \"required\": true,\n  \"props\": {\n    \"name\": {\n      \"kind\": \"irreducible\",\n      \"name\": \"String\",\n      \"required\": true\n    },\n    \"age\": {\n      \"kind\": \"irreducible\",\n      \"name\": \"Number\",\n      \"required\": false\n    }\n  }\n}\n```\n\n## Output format\n\n### Irriducible\n\n**Source**\n\n```js\nt.String\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"irreducible\",\n  \"required\": true,\n  \"name\": \"String\",\n  \"predicate\": \"<function reference>\"\n}\n```\n\n### Refinement\n\n**Source**\n\n```js\nconst Password = t.refinement(t.String, (s) => s.length >= 6, 'Password')\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"refinement\",\n  \"required\": true,\n  \"name\": \"Password\",\n  \"type\": {\n    \"kind\": \"irreducible\",\n    \"name\": \"String\",\n    \"required\": true,\n    \"predicate\": \"<function reference>\"\n  },\n  \"predicate\": \"<function reference>\"\n}\n```\n\n### Maybe\n\n**Source**\n\n```js\nconst MaybeString = t.maybe(t.String)\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"irreducible\",\n  \"required\": false,\n  \"name\": \"String\",\n  \"predicate\": \"<function reference>\"\n}\n```\n\n### Enum\n\n**Source**\n\n```js\nconst Country = t.enums({\n  IT: 'Italy',\n  US: 'United States'\n}, 'Country')\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"enums\",\n  \"required\": false,\n  \"name\": \"Country\",\n  \"map\": {\n    IT: 'Italy',\n    US: 'United States'\n  }\n}\n```\n\n### Struct\n\n**Source**\n\n```js\nconst Person = t.struct({\n  name: t.String,\n  age: t.Number\n}, 'Person')\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"struct\",\n  \"required\": false,\n  \"name\": \"Person\",\n  \"props\": {\n    \"name\": {\n      \"kind\": \"irreducible\",\n      \"required\": true,\n      \"name\": \"String\",\n      \"predicate\": \"<function reference>\"\n    },\n    ...\n  }\n}\n```\n\n### List\n\n**Source**\n\n```js\nconst Tags = t.list(t.String, 'Tags')\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"list\",\n  \"required\": true,\n  \"name\": \"Tags\",\n  \"type\": {\n    \"kind\": \"irreducible\",\n    \"name\": \"String\",\n    \"required\": true,\n    \"predicate\": \"<function reference>\"\n  }\n}\n```\n\n### Tuple\n\n**Source**\n\n```js\nconst Tuple = t.tuple([t.String, t.Number], 'Tuple')\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"tuple\",\n  \"name\": \"Tuple\",\n  \"required\": true,\n  \"types\": [\n    {\n      \"kind\": \"irreducible\",\n      \"required\": true,\n      \"name\": \"String\",\n      \"predicate\": \"<function reference>\"\n    },\n    {\n      \"kind\": \"irreducible\",\n      \"required\": true,\n      \"name\": \"Number\",\n      \"predicate\": \"<function reference>\"\n    }\n  ]\n}\n```\n\n### Union\n\n**Source**\n\n```js\nconst Union = t.union([t.String, t.Number], 'Union')\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"union\",\n  \"name\": \"Union\",\n  \"required\": true,\n  \"types\": [\n    {\n      \"kind\": \"irreducible\",\n      \"required\": true,\n      \"name\": \"String\",\n      \"predicate\": \"<function reference>\"\n    },\n    {\n      \"kind\": \"irreducible\",\n      \"required\": true,\n      \"name\": \"Number\",\n      \"predicate\": \"<function reference>\"\n    }\n  ],\n  \"dispatch\": \"<function reference>\"\n}\n```\n\n### Dict\n\n**Source**\n\n```js\nconst Dict = t.dict(t.String, t.Number, 'Dict')\n```\n\n**Output**\n\n```js\n{\n  \"kind\": \"dict\",\n  \"name\": \"Dict\",\n  \"required\": true,\n  \"domain\": {\n    \"kind\": \"irreducible\",\n    \"required\": true,\n    \"name\": \"String\",\n    \"predicate\": \"<function reference>\"\n    },\n    \"codomain\": {\n      \"kind\": \"irreducible\",\n      \"required\": true,\n      \"name\": \"Number\",\n      \"predicate\": \"<function reference>\"\n    }\n}\n```\n","maintainers":[{"name":"gcanti","email":"giulio.canti@gmail.com"}],"time":{"modified":"2022-06-27T04:14:19.550Z","created":"2014-09-08T07:35:30.209Z","0.2.1":"2014-09-08T07:35:30.209Z","0.2.2":"2014-09-08T07:57:10.025Z","0.2.3":"2014-11-04T16:04:07.302Z","0.3.0":"2015-03-22T15:30:54.034Z","0.4.0":"2016-01-09T17:49:01.643Z","0.5.0":"2016-03-07T12:08:38.816Z","0.5.1":"2016-05-15T06:59:01.409Z","0.5.2":"2016-06-03T08:28:39.233Z"},"homepage":"https://github.com/gcanti/tcomb-doc","repository":{"type":"git","url":"git+https://github.com/gcanti/tcomb-doc.git"},"author":{"name":"Giulio Canti","email":"giulio.canti@gmail.com"},"bugs":{"url":"https://github.com/gcanti/tcomb-doc/issues"},"license":"MIT","readmeFilename":"README.md","keywords":["tcomb","documentation","tool"]}