{"_id":"@bb-cli/json-schema-to-typedef","_rev":"15-036ddddf24b3b3fcc4be263f593008e5","name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","dist-tags":{"latest":"0.4.1"},"versions":{"0.1.0":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.1.0","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{},"devDependencies":{},"_id":"@bb-cli/json-schema-to-typedef@0.1.0","scripts":{},"_shasum":"946ffe9e76106aae5bf66de3e440f5041f2a49ef","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"bb-cli","email":"dragos@backbase.com"},"dist":{"shasum":"946ffe9e76106aae5bf66de3e440f5041f2a49ef","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.1.0.tgz","integrity":"sha512-i7Nq7LaFSbvmloDFGw9DgtRZpgsJQzsh3MwuQfHAapOub7UX3HUwZv2wFBUGQ92w6INYLNsVf7oylbU4ZyFumA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC8Bmz5jLmGjOM5eRt77nmfeYPqC3ZCxMJF71M0TrHMxwIgb0kBMlubagmW7patDaBDEK99+QxwDtsXOnL2QJWt5vw="}]},"maintainers":[{"name":"bb-cli","email":"dragos@backbase.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/json-schema-to-typedef-0.1.0.tgz_1486986182513_0.26330424402840436"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.1.1":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.1.1","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{},"devDependencies":{},"_id":"@bb-cli/json-schema-to-typedef@0.1.1","scripts":{},"_shasum":"8f3e10e041c1c64595558b53f22803d52d9578ef","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"bb-cli","email":"dragos@backbase.com"},"dist":{"shasum":"8f3e10e041c1c64595558b53f22803d52d9578ef","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.1.1.tgz","integrity":"sha512-SxeRxrAovWgMKzLIvtZwGqy2ePSkkrb7wavngIcDIw6uUwlQoMYGFN7lb2G80pdxW20A3UKhv7dOXz3XAIxl0w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCEszER5BxOEVJ+2VxWItOsDMru6lVficrJlm6nUIg/GwIgY+e5mzAKWoQWLD/PjURsGQW5IWYRGIF2Ew2z/acnrN0="}]},"maintainers":[{"name":"bb-cli","email":"dragos@backbase.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/json-schema-to-typedef-0.1.1.tgz_1486992419514_0.6343661930877715"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.1.2":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.1.2","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{},"devDependencies":{},"_id":"@bb-cli/json-schema-to-typedef@0.1.2","scripts":{},"_shasum":"cebe779c32ef813b57243782a7f5c0aad6b1f512","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"bb-cli","email":"dragos@backbase.com"},"dist":{"shasum":"cebe779c32ef813b57243782a7f5c0aad6b1f512","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.1.2.tgz","integrity":"sha512-cYzNOUnSpoFEIud0H+7oEni/Si0Rpgqd7oOI8SMbCtplXiqhMZeHH30zsVMyhhGe7Z0gDXhLzn+g2xGYD90JhQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIB/Bj5Vy3ucO7K3n9ymAXCIjyGO9fp+o1f7dxwP7edOiAiEAlnNDhlrgY9KZsS+OCJUCHjE5iwR1C+aKEb+2hMjX6+0="}]},"maintainers":[{"name":"bb-cli","email":"dragos@backbase.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/json-schema-to-typedef-0.1.2.tgz_1486993037002_0.35944307618774474"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.1.3":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.1.3","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{},"devDependencies":{},"_id":"@bb-cli/json-schema-to-typedef@0.1.3","scripts":{},"_shasum":"7282896334d6f211131d4363aba912a6cbd88243","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"bb-cli","email":"dragos@backbase.com"},"dist":{"shasum":"7282896334d6f211131d4363aba912a6cbd88243","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.1.3.tgz","integrity":"sha512-vGEuNOHW+MicTrnF9X3XM+dZGITvRi6s1Kl3hukmIHiTs5ErMRoySw4KgBjbiJmUjgugZEy/Cpv7B/+7dzbgYg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCiGM0p+2625Hz6Rb2LO79/TbRuakUz17KipQENc3PgmwIgQyt1gcny3Nqj8+ljw0YN9U3fx4VsXIe24EuwoGvkjL0="}]},"maintainers":[{"name":"bb-cli","email":"dragos@backbase.com"}],"_npmOperationalInternal":{"host":"packages-18-east.internal.npmjs.com","tmp":"tmp/json-schema-to-typedef-0.1.3.tgz_1486993197781_0.07369960146024823"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.3.0":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.3.0","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{"json-schema-ref-parser":"^3.1.2"},"devDependencies":{},"_id":"@bb-cli/json-schema-to-typedef@0.3.0","scripts":{},"_shasum":"e75f53a91f23e5b7f6169bec04f5b2827176aea5","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"bb-cli","email":"dragos@backbase.com"},"dist":{"shasum":"e75f53a91f23e5b7f6169bec04f5b2827176aea5","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.3.0.tgz","integrity":"sha512-THT48B6DT8o/qM0iklv6tNLSxN95/6hQq9ClYU9R35Jr8OEwz1H6FhxFS6r+IN2QUPJ/ET5DIDo+veivGVC2YA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDmn8CXMg3QtCNz+R+tyVwnWmC2P6Nh1FxuW2LrTA2J3AIhAJpXfAgnGIGYhxZJ1rFBaQICClM4LPTNh/F6HilHzJ3V"}]},"maintainers":[{"name":"bb-cli","email":"dragos@backbase.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/json-schema-to-typedef-0.3.0.tgz_1491909133595_0.44353219168260694"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.3.1":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.3.1","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{"json-schema-ref-parser":"^3.1.2"},"devDependencies":{},"_id":"@bb-cli/json-schema-to-typedef@0.3.1","scripts":{},"_shasum":"40bf98f863001069d0cc69b79523222030db80bd","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"bb-cli","email":"dragos@backbase.com"},"dist":{"shasum":"40bf98f863001069d0cc69b79523222030db80bd","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.3.1.tgz","integrity":"sha512-aD0zTl1K+e9W5feb7wWaOo0vPe674XjRQTX3Iq5drImGn9dH/FybhZGdLWas7mIH5cieKJx69IYiF77TVsAWEw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCIqxg6S62rVf2/i45NDYXLO9+dLzYtdlCrHnBWbt9QCQIgDCvk6oJihRE9+CiZq5n9Rj5/J7IOpgt5wDCj9B/8rog="}]},"maintainers":[{"name":"bb-cli","email":"dragos@backbase.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/json-schema-to-typedef-0.3.1.tgz_1500542675776_0.6885606457944959"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.3.2":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.3.2","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{"json-schema-ref-parser":"^3.1.2"},"devDependencies":{},"keywords":["bb-cli-lib"],"_id":"@bb-cli/json-schema-to-typedef@0.3.2","scripts":{},"_shasum":"5ac39d2a4902e354103591b8e167b7a5cad0e692","_from":".","_npmVersion":"3.10.8","_nodeVersion":"6.9.1","_npmUser":{"name":"bb-cli","email":"npm@backbase.com"},"dist":{"shasum":"5ac39d2a4902e354103591b8e167b7a5cad0e692","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.3.2.tgz","integrity":"sha512-1WitebdMaq2kvBkSOIqLZPStaiMNYdxXspjdbEBNH+vls+PYwLYun8zMOS26+rNfjed7Vj836ECmgp0TwwpPzw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCYbSZrvbjGz3RiItKY0jEYGLLJCjvGKnyEWZDZlKYOYQIgDq8LCgiZYMmWiDhsn7OZATFf9SOC0cG6XiWCeKu+kr4="}]},"maintainers":[{"email":"npm@backbase.com","name":"bb-cli"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/json-schema-to-typedef-0.3.2.tgz_1505998326206_0.11204191530123353"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.4.0":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.4.0","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{"json-schema-ref-parser":"^3.1.2"},"devDependencies":{},"keywords":["bb-cli-lib"],"_id":"@bb-cli/json-schema-to-typedef@0.4.0","_npmVersion":"5.5.1","_nodeVersion":"8.9.1","_npmUser":{"name":"bb-cli","email":"npm@backbase.com"},"dist":{"integrity":"sha512-qCQp/+B8HZOdKoRVz41V3Hw+dXEl6ogCXQBbLG01TRZSvpWnTI5k6PP16Y14XdUCmzYsujWun6h8ypAGlYTqxA==","shasum":"141a7fb3d22844bccc72de72852245f8e79ef195","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.4.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCgA/zEteQf7fVLhce3CmvgJ3bjoDfM89SzMXuh9ou0zAIhALbVQhoS5qrj2LbuY2kl+3jtAuY4KpuW1fWdzECDQDEx"}]},"maintainers":[{"email":"npm@backbase.com","name":"bb-cli"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/json-schema-to-typedef-0.4.0.tgz_1515597544423_0.7348218713887036"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.4.1":{"name":"@bb-cli/json-schema-to-typedef","description":"Convert json schema to js doc typedef","version":"0.4.1","jsnext:main":"src/index.js","main":"dist/index.js","license":"SEE LICENSE IN LICENSE","private":false,"dependencies":{"json-schema-ref-parser":"^3.1.2"},"devDependencies":{},"keywords":["bb-cli-lib"],"_id":"@bb-cli/json-schema-to-typedef@0.4.1","_npmVersion":"5.5.1","_nodeVersion":"8.9.1","_npmUser":{"name":"bb-cli","email":"npm@backbase.com"},"dist":{"integrity":"sha512-OTGEGRmONJV/HuwqxPaWf8qtalrqrjxvlIUElRAEO4AWeggvq9Y0pabguXht1nCsvfsFBzZv543Fj8joXXH7WA==","shasum":"0699f7efc5cb9cd95054b65dabadb5b2159797ca","tarball":"https://registry.npmjs.org/@bb-cli/json-schema-to-typedef/-/json-schema-to-typedef-0.4.1.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH+U9Ug2WtnYLktXPCcfN735DzaGOBxW4VASJj+6ByOfAiA5evfFZaC0WKummDsHkNLOr4dI7390Y0f6G4Wb3jl9ww=="}]},"maintainers":[{"email":"npm@backbase.com","name":"bb-cli"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/json-schema-to-typedef-0.4.1.tgz_1516108296728_0.6383113290648907"},"directories":{},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"readme":"## Members\n\n
\n
jsonSchemaToTypeDefObjs ⇒ Promise.<Array.<TypeDef>>
\n

Convert json schema to js doc typeDef objects.

\n
\n
default ⇒ Promise.<Array.<String>>
\n

Convert json schema to js doc typeDef strings

\n
\n
typeDefToString ⇒ String
\n

Convert a typedef object to a JS Doc string

\n
\n
\n\n## Typedefs\n\n
\n
TypeDefProperty : Object
\n

JS Doc Object property

\n
\n
TypeDef : Object
\n

JS Doc typedef

\n
\n
\n\n\n\n## jsonSchemaToTypeDefObjs ⇒ Promise.<Array.<TypeDef>>\nConvert json schema to js doc typeDef objects.\n\n**Kind**: global variable \n**Returns**: Promise.<Array.<TypeDef>> - Promise of array of typeDef objects \n\n| Param | Type | Description |\n| --- | --- | --- |\n| schema | Object | JSON Schema to Convert |\n| name | String | Top level name for typeDefs |\n\n**Example** \n```javascript\nimport { jsonSchemaToTypeDefObjs } from '@bb-cli/json-schema-to-typeDef';\n\nconst jsonSchema = {\n type: 'array',\n items: {\n type: 'object',\n properties: {\n oneProperty: {\n type: 'string',\n },\n twoProperty: {\n type: 'object',\n properties: {\n nestedProperty: {\n type: 'number'\n }\n }\n },\n },\n required: [\"twoProperty\"]\n },\n};\n\nconsole.log(jsonSchemaToTypeDefObjs(jsonSchema, 'myType'));\n\n// Outputs array of 3 typedef objects:\n[\n {\n name: \"myType\",\n type: \"Array.\",\n properties: []\n },\n {\n name: \"myTypeItem\",\n type: \"Object\",\n properties: [\n {\n name: \"oneProperty\",\n isRequired: false,\n type: \"String\",\n description: \"\"\n },\n {\n name: \"twoProperty\",\n isRequired: true,\n type: \"twoProperty\",\n description: \"\"\n }\n ]\n },\n {\n name: \"twoProperty\",\n type: \"Object\",\n properties: [\n {\n name: \"nestedProperty\",\n isRequired: false,\n type: \"Number\",\n description: \"\"\n }\n ]\n }\n]\n```\n\n\n## default ⇒ Promise.<Array.<String>>\nConvert json schema to js doc typeDef strings\n\n**Kind**: global variable \n**Returns**: Promise.<Array.<String>> - Promise of Array of typeDef strings \n\n| Param | Type | Description |\n| --- | --- | --- |\n| schema | Object | JSON Schema to Convert |\n| name | String | Top level name for typeDefs |\n\n**Example** \n```javascript\nimport jsonSchemaToTypeDef from '@bb-cli/json-schema-to-typeDef';\n\nconst jsonSchema = {\n type: 'array',\n items: {\n type: 'object',\n properties: {\n oneProperty: {\n type: 'string',\n },\n twoProperty: {\n type: 'object',\n properties: {\n nestedProperty: {\n type: 'number'\n }\n }\n },\n },\n required: [\"twoProperty\"]\n },\n};\n\nconsole.log(jsonSchemaToTypeDef(jsonSchema, 'myType'));\n\n// Outputs array of 3 typedef strings:\n[\n \"@typedef myType\n @type {Array.}\",\n\n \"@typedef myTypeItem\n @type {Object}\n @property {?String} oneProperty\n @property {twoProperty} twoProperty\",\n\n \"@typedef twoProperty\n @type {Object}\n @property {?Number} nestedProperty\"\n];\n```\n\n\n## typeDefToString ⇒ String\nConvert a typedef object to a JS Doc string\n\n**Kind**: global variable \n\n| Param | Type |\n| --- | --- |\n| def | [TypeDef](#TypeDef) | \n\n\n\n## TypeDefProperty : Object\nJS Doc Object property\n\n**Kind**: global typedef \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of object property |\n| isRequired | Boolean | Whether property is required for object |\n| type | String | JS Doc type of property |\n| description | String | Description of the property |\n\n\n\n## TypeDef : Object\nJS Doc typedef\n\n**Kind**: global typedef \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| name | String | Name of typedef |\n| type | String | JS Doc type of typedef |\n| properties | [Array.<TypeDefProperty>](#TypeDefProperty) | Array of typedef object properties |\n\n","maintainers":[{"email":"ben@backbase.com","name":"backbase-admin"},{"email":"npm@backbase.com","name":"bb-cli"}],"time":{"modified":"2022-07-20T12:50:09.223Z","created":"2017-02-13T11:43:04.388Z","0.1.0":"2017-02-13T11:43:04.388Z","0.1.1":"2017-02-13T13:27:01.555Z","0.1.2":"2017-02-13T13:37:18.939Z","0.1.3":"2017-02-13T13:39:58.345Z","0.3.0":"2017-04-11T11:12:15.504Z","0.3.1":"2017-07-20T09:24:36.779Z","0.3.2":"2017-09-21T12:52:07.336Z","0.4.0":"2018-01-10T15:19:05.374Z","0.4.1":"2018-01-16T13:11:36.818Z"},"license":"SEE LICENSE IN LICENSE","readmeFilename":"README.md","keywords":["bb-cli-lib"]}