1.0.2 • Published 6 years ago
preos v1.0.2
Readme
Preos is a js
library to transpile and interprete other languages than HTML
, CSS
and JS
in runtime.
Installation
In your project type the following command to include it in your dependencies:
npm install --save preos
const preos = require('preos');
Documentation
To use this library just require it in your js
file and start using it:
const preos = require('preos');
// TypeScript to JavaScript transpiler example.
(async function () {
var result;
try {
result = await preos.transpile({
url: "path/to/file.ts",
outputLang: "js"
});
console.log(result.source);
}
catch (why) {
console.log("[ERROR]: ", why.stack);
}
})();
If you want more details take a look at the API.
Default configuration
preos
comes with a set of pre-configured preprocessors to use just only requiring the library:
Default transpilers:
Default interpreters:
- JavaScript
js
: executes itself. - TypeScript
ts
: transpiles the code intojs
and then executes it. - PUG
pug
: returns afunction
that accepts anobject
with the properties to fill the template and then returns its equivalent code inhtml
. - VUE
vue
: returns a function that lazily will compile the template and returns anobject
prepared for be use with the Vue library. - JSON
json
: returns anobject
that represents its structure. - XML
xml
: returns anobject
that represents its structure. More information here. - TOML
toml
: returns anobject
that represents its structure.
Contributing
Fixes and improvements are always welcome, so if you want to contribute helping out or warning about an error, send me an email or open an issue.