Enonic XP lib-io TS types

> TypeScript definitions for lib-io library of Enonic XP

Install

``bash
npm i --save-dev @enonic-types/lib-io
`

Use

$3

To make require work out of the box, you must install and add the @enonic-types/global types. Aside from providing definitions for XP
global objects, e.g. log, app, __, etc, requiring a library by the default path will return typed object.

tsconfig.json

`json
{
"compilerOptions": {
"types": [
"@enonic-types/global"
]
}
}
`

example.ts

`ts
const {readText, readLines, processLines, getSize, getMimeType, newStream, getResource} = require('/lib/xp/io');
`

More detailed explanation on how it works and how to type custom import function can be
found here.

$3

If you are planning to use import in your code and transpile it with the default tsc TypeScript compiler, you'll need to add proper
types mapping to your configuration.

tsconfig.json

`json
{
"compilerOptions": {
"baseUrl": "./",
"paths": {
"/lib/xp/io": ["node_modules/@enonic-types/lib-io"]
}
}
}
`

example.ts

`ts
import {readText, readLines, processLines, getSize, getMimeType, newStream, getResource} from '/lib/xp/io';
`

Setting baseUrl and paths will allow the tsc` to keep the valid paths in the resulting JavaScript files.