{"_id":"jstransformer","_rev":"25-4fb055c029ba129847419f62df4bfbde","name":"jstransformer","description":"Normalize the API of any jstransformer","dist-tags":{"latest":"1.0.0"},"versions":{"0.0.0":{"name":"jstransformer","version":"0.0.0","description":"Normalize the API of any jstransformer","keywords":[],"dependencies":{"promise":"^6.0.1"},"devDependencies":{},"scripts":{"test":"node test"},"repository":{"type":"git","url":"https://github.com/jstransformers/jstransformer.git"},"author":{"name":"ForbesLindesay"},"license":"MIT","gitHead":"a6c22a5115c49c3fd85d828c9a73b53f0783f395","bugs":{"url":"https://github.com/jstransformers/jstransformer/issues"},"homepage":"https://github.com/jstransformers/jstransformer","_id":"jstransformer@0.0.0","_shasum":"81bf714ce8478c934ba89c4d87d83384ff1e074e","_from":".","_npmVersion":"1.5.0-alpha-4","_npmUser":{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"},"maintainers":[{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"}],"dist":{"shasum":"81bf714ce8478c934ba89c4d87d83384ff1e074e","tarball":"https://registry.npmjs.org/jstransformer/-/jstransformer-0.0.0.tgz","integrity":"sha512-bS4IZsmktymyjnwy4yWH7WcHDa0wpXYLSks6DxyrYYblSDWIf7kmhZFSRKByqNt8pCCGmTpE+AbYbK/cpFtDbQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDNqeoXzpoXBKAa90WsnZrjdZVWlhOdljS7YcrlU1SATgIgEgJK31etMYfeIQTkxOOp/UFXBdZMFPqtQVSriS5N9AM="}]}},"0.0.1":{"name":"jstransformer","version":"0.0.1","description":"Normalize the API of any jstransformer","keywords":["jstransformer"],"dependencies":{"promise":"^6.0.1"},"devDependencies":{"istanbul":"^0.3.5","testit":"^1.2.0"},"scripts":{"test":"node test","coverage":"istanbul cover test/index.js"},"repository":{"type":"git","url":"https://github.com/jstransformers/jstransformer.git"},"author":{"name":"ForbesLindesay"},"license":"MIT","gitHead":"c9e437cba3e56def57887a7ca8adb73bbea7040c","bugs":{"url":"https://github.com/jstransformers/jstransformer/issues"},"homepage":"https://github.com/jstransformers/jstransformer","_id":"jstransformer@0.0.1","_shasum":"950c5878729a2624f3013fc252833300c4cd163a","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"},"maintainers":[{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"}],"dist":{"shasum":"950c5878729a2624f3013fc252833300c4cd163a","tarball":"https://registry.npmjs.org/jstransformer/-/jstransformer-0.0.1.tgz","integrity":"sha512-fb4KeJgQFgpehb3IDwZV6zbMrhvoLsW/9rI+jgIcThP7+D7TTUfJDxJ1gQJNc9m+BbeR/rol7w/bDVF7YVasDQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHlrPwgH+qvvg8cLuXz4SFf1ANJ3zN1MQ1/rpcfPIYr6AiEA3OUeIDYcsNScAsuL/wSAS7eCtx2L7/VPfpwj667OhiU="}]}},"0.0.2":{"name":"jstransformer","version":"0.0.2","description":"Normalize the API of any jstransformer","keywords":["jstransformer"],"dependencies":{"is-promise":"^2.0.0","promise":"^6.0.1"},"devDependencies":{"coveralls":"^2.11.2","istanbul":"^0.3.5","testit":"^1.2.0"},"scripts":{"test":"node test","coverage":"istanbul cover test","coveralls":"npm run coverage && cat ./coverage/lcov.info | coveralls"},"files":["index.js","LICENSE"],"repository":{"type":"git","url":"https://github.com/jstransformers/jstransformer.git"},"author":{"name":"ForbesLindesay"},"license":"MIT","gitHead":"99b40c1aa9fa984585aa50f4618d97a0287495c1","bugs":{"url":"https://github.com/jstransformers/jstransformer/issues"},"homepage":"https://github.com/jstransformers/jstransformer","_id":"jstransformer@0.0.2","_shasum":"7aae29a903d196cfa0973d885d3e47947ecd76ab","_from":".","_npmVersion":"2.7.1","_nodeVersion":"1.6.2","_npmUser":{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"},"maintainers":[{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"}],"dist":{"shasum":"7aae29a903d196cfa0973d885d3e47947ecd76ab","tarball":"https://registry.npmjs.org/jstransformer/-/jstransformer-0.0.2.tgz","integrity":"sha512-b7tmf91j1ChMuYhwbPBnNgB62dmHuqiHpOdd6QLKzde8HydZqm+ud3qWreGWecSxPBFFNOf1Ozjx0xo2plFdHA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCalz2jwtOtzIKkSDkNeDRNS82M2ySYuA4fancFhj0upQIhAOjgXGrIsxad+DoBusq0P17AeG7XyYG/Us4glFBbkPEZ"}]}},"0.0.3":{"name":"jstransformer","version":"0.0.3","description":"Normalize the API of any jstransformer","keywords":["jstransformer"],"dependencies":{"is-promise":"^2.0.0","promise":"^7.0.1"},"devDependencies":{"coveralls":"^2.11.2","istanbul":"^0.3.5","testit":"^2.0.2"},"scripts":{"test":"node test","coverage":"istanbul cover test","coveralls":"npm run coverage && cat ./coverage/lcov.info | coveralls"},"files":["index.js","LICENSE"],"repository":{"type":"git","url":"git+https://github.com/jstransformers/jstransformer.git"},"author":{"name":"ForbesLindesay"},"license":"MIT","gitHead":"57198ce3483f51ee092895c243cb88162f843dcd","bugs":{"url":"https://github.com/jstransformers/jstransformer/issues"},"homepage":"https://github.com/jstransformers/jstransformer#readme","_id":"jstransformer@0.0.3","_shasum":"347495bd3fe1cfe8f03e2d71578acb9024826cf5","_from":".","_npmVersion":"2.10.1","_nodeVersion":"0.12.4","_npmUser":{"name":"robloach","email":"robloach@gmail.com"},"dist":{"shasum":"347495bd3fe1cfe8f03e2d71578acb9024826cf5","tarball":"https://registry.npmjs.org/jstransformer/-/jstransformer-0.0.3.tgz","integrity":"sha512-QNVOugrVtUhxx6Ft1xXViaSmNjOjKq/eSuZRCZSSN/oUiB/09GFVMFQ7XMJOchCn7F8AKtI46PlKUaWZD1Dc9g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIB2aFnymAtptPOOGCMumxldyvyi3IjfAUbe+4P9vJLD7AiEA46lV0HXSolaEMFDwLUcMN8NVgSd1bIAeI3qgAuOwAZM="}]},"maintainers":[{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"},{"name":"tunnckocore","email":"mameto_100@mail.bg"},{"name":"robloach","email":"robloach@gmail.com"},{"name":"hemanth","email":"hemanth.hm@gmail.com"},{"name":"timothygu","email":"timothygu99@gmail.com"},{"name":"stoeffel","email":"schtoeffel@gmail.com"}]},"0.0.4":{"name":"jstransformer","version":"0.0.4","description":"Normalize the API of any jstransformer","keywords":["jstransformer"],"dependencies":{"is-promise":"^2.0.0","promise":"^7.0.1"},"devDependencies":{"coveralls":"^2.11.2","istanbul":"^0.4.0","testit":"^2.0.2"},"scripts":{"test":"node test","coverage":"istanbul cover test","coveralls":"npm run coverage && cat ./coverage/lcov.info | coveralls"},"files":["index.js"],"repository":{"type":"git","url":"git+https://github.com/jstransformers/jstransformer.git"},"author":{"name":"ForbesLindesay"},"license":"MIT","gitHead":"67231174793c940ec18830ed92ffa0a2f3ef8950","bugs":{"url":"https://github.com/jstransformers/jstransformer/issues"},"homepage":"https://github.com/jstransformers/jstransformer#readme","_id":"jstransformer@0.0.4","_shasum":"8ec12cead9dfe0aae8c852c3aade653a8ccab1f9","_from":".","_npmVersion":"3.3.6","_nodeVersion":"5.0.0","_npmUser":{"name":"robloach","email":"robloach@gmail.com"},"dist":{"shasum":"8ec12cead9dfe0aae8c852c3aade653a8ccab1f9","tarball":"https://registry.npmjs.org/jstransformer/-/jstransformer-0.0.4.tgz","integrity":"sha512-k1aQY1kmm/ZaoojTZio3uZF9MOetLEIsrjIua0adZwFncoW6Zcp+sIY/Y2OW9s9F10w3pMUoLrO86VXdFv5wcw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBvN9d8PcZJ6eGcJbBOigUPEcCXZ9VGcOr9bRDpW91wcAiBDzrWVDfceuykkosIQ9YKTeV0yjFOX3hg2nUsJyv4LQA=="}]},"maintainers":[{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"},{"name":"hemanth","email":"hemanth.hm@gmail.com"},{"name":"robloach","email":"robloach@gmail.com"},{"name":"stoeffel","email":"schtoeffel@gmail.com"},{"name":"timothygu","email":"timothygu99@gmail.com"}]},"1.0.0":{"name":"jstransformer","version":"1.0.0","description":"Normalize the API of any jstransformer","keywords":["jstransformer"],"dependencies":{"is-promise":"^2.0.0","promise":"^7.0.1"},"devDependencies":{"coveralls":"^2.11.2","istanbul":"^0.4.0","testit":"^2.0.2"},"scripts":{"test":"node test","coverage":"istanbul cover test","coveralls":"npm run coverage && cat ./coverage/lcov.info | coveralls"},"files":["index.js"],"repository":{"type":"git","url":"git+https://github.com/jstransformers/jstransformer.git"},"author":{"name":"ForbesLindesay"},"license":"MIT","gitHead":"7cad069255989318fc5638228fd2fa54fe35992f","bugs":{"url":"https://github.com/jstransformers/jstransformer/issues"},"homepage":"https://github.com/jstransformers/jstransformer#readme","_id":"jstransformer@1.0.0","_shasum":"ed8bf0921e2f3f1ed4d5c1a44f68709ed24722c3","_from":".","_npmVersion":"3.9.6","_nodeVersion":"6.2.1","_npmUser":{"name":"timothygu","email":"timothygu99@gmail.com"},"dist":{"shasum":"ed8bf0921e2f3f1ed4d5c1a44f68709ed24722c3","tarball":"https://registry.npmjs.org/jstransformer/-/jstransformer-1.0.0.tgz","integrity":"sha512-C9YK3Rf8q6VAPDCCU9fnqo3mAfOH6vUGnMcP4AQAYIEpWtfGLpwOTmZ+igtdK5y+VvI2n3CyYSzy4Qh34eq24A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDj5SgeQeVRTlALqwdBeACRI5WIit1ZyqxQ5bjzZ/8FqAiEAirUSD59IrGlR0WiwBU0HR7vugY46eSpAgWaiRTKl8xY="}]},"maintainers":[{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"},{"name":"hemanth","email":"hemanth.hm@gmail.com"},{"name":"robloach","email":"robloach@gmail.com"},{"name":"stoeffel","email":"schtoeffel@gmail.com"},{"name":"timothygu","email":"timothygu99@gmail.com"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/jstransformer-1.0.0.tgz_1465175586831_0.4917067172937095"}}},"readme":"
\n
JSTransformer
\n
Normalize the API of any jstransformer
\n\n
\n\n\n\n
\n\n## Installation\n\n npm install jstransformer\n\n## Usage\n\n```js\nvar transformer = require('jstransformer');\nvar marked = transformer(require('jstransformer-marked'));\n\nvar options = {};\nvar res = marked.render('Some **markdown**', options);\n// => {body: 'Some markdown', dependencies: []}\n```\n\nThis gives the same API regardless of the jstransformer passed in.\n\n## API\n\nA transformer, once normalised using this module, will implement the following methods. Note that if the underlying transformer cannot be used to implement the functionality, it may ultimately just throw an error.\n\n### Returned object from `.render*`\n\n```js\n{body: String, dependencies: Array.}\n```\n\n - `body` represents the result as a string\n - `dependencies` is an array of files that were read in as part of the render process (or an empty array if there were no dependencies)\n\n### `.render`\n\n```js\ntransformer.render(str, options, locals);\n=> {body: String, dependencies: Array.}\n```\n\n_requires the underlying transform to implement `.render` or `.compile`_\n\nTransform a string and return an object.\n\n### `.renderAsync`\n\n```js\ntransformer.renderAsync(str[, options], locals, callback);\n```\n\n```js\ntransformer.renderAsync(str[, options], locals);\n=> Promise({body: String, dependencies: Array.})\n```\n\n_requires the underlying transform to implement `.renderAsync` or `.render`_\n\nTransform a string asynchronously. If a callback is provided, it is called as `callback(err, data)`, otherwise a Promise is returned.\n\n### `.renderFile`\n\n```js\ntransformer.renderFile(filename, options, locals)\n=> {body: String, dependencies: Array.}\n```\n\n_requires the underlying transform to implement `.renderFile`, `.render`, `.compileFile`, or `.compile`_\n\nTransform a file and return an object.\n\n### `.renderFileAsync`\n\n```js\ntransformer.renderFileAsync(filename[, options], locals, callback);\n```\n\n```js\ntransformer.renderFileAsync(filename[, options], locals);\n=> Promise({body: String, dependencies: Array.})\n```\n\n_requires the underlying transform to implement `.renderFileAsync`, `.renderFile`, `.renderAsync`, `.render`, `.compileFileAsync`, `.compileFile`, `.compileAsync`, or `.compileFile`_\n\nTransform a file asynchronously. If a callback is provided, it is called as `callback(err, data)`, otherwise a Promise is returned.\n\n### `.inputFormats`\n\n```js\nvar formats = transformer.inputFormats;\n=> ['md', 'markdown']\n```\n\nReturns an array of strings representing potential input formats for the transform. If not provided directly by the transform, results in an array containing the name of the transform.\n\n### `.outputFormat`\n\n```js\nvar md = require('jstransformer')(require('jstransformer-markdown'))\nvar outputFormat = md.outputFormat\n=> 'html'\n```\n\nReturns a string representing the default output format the transform would be expected to return when calling `.render()`.\n\n## License\n\nMIT\n","maintainers":[{"name":"calebeby","email":"caleb.eby01@gmail.com"},{"name":"forbeslindesay","email":"forbes@lindesay.co.uk"},{"name":"hemanth","email":"hemanth.hm@gmail.com"},{"name":"robloach","email":"robloach@gmail.com"},{"name":"stoeffel","email":"schtoeffel@gmail.com"},{"name":"timothygu","email":"timothygu99@gmail.com"}],"time":{"modified":"2022-06-19T07:00:11.287Z","created":"2014-11-18T17:19:18.314Z","0.0.0":"2014-11-18T17:19:18.314Z","0.0.1":"2015-02-09T22:32:01.028Z","0.0.2":"2015-04-12T02:57:12.696Z","0.0.3":"2015-07-13T10:20:49.591Z","0.0.4":"2015-11-23T10:35:17.137Z","1.0.0":"2016-06-06T01:13:09.732Z"},"homepage":"https://github.com/jstransformers/jstransformer#readme","keywords":["jstransformer"],"repository":{"type":"git","url":"git+https://github.com/jstransformers/jstransformer.git"},"author":{"name":"ForbesLindesay"},"bugs":{"url":"https://github.com/jstransformers/jstransformer/issues"},"license":"MIT","readmeFilename":"README.md","users":{"robloach":true,"nelix":true,"eshinn":true,"seangenabe":true,"dduran1967":true,"zuojiang":true}}
![](\"https://cdn.rawgit.com/jstransformers/jstransformer/2bb6dc6c410e8683a17a4af5f1b73bcbee95aada/logo.svg\"){kind=logo}
![\"Build](\"https://img.shields.io/travis/jstransformers/jstransformer/master.svg\")
\n![\"Dependency](\"https://img.shields.io/david/jstransformers/jstransformer.svg\")
\n![\"Developers'](\"https://img.shields.io/david/dev/jstransformers/jstransformer.svg\")
\n![\"Coverage](\"https://img.shields.io/coveralls/jstransformers/jstransformer/master.svg\")
\n![\"NPM](\"https://img.shields.io/npm/v/jstransformer.svg\")