Socket
Socket
Sign inDemoInstall

@enonic-types/lib-context

Package Overview
Dependencies
1
Maintainers
0
Versions
39
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@enonic-types/lib-context

Type definitions for lib-context.


Version published
Maintainers
0
Created

Readme

Source

Enonic XP lib-context TS types

TypeScript definitions for lib-context library of Enonic XP

Install

npm i --save-dev @enonic-types/lib-context

Use

Require and custom imports

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

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

example.ts

const {get, run} = require('/lib/xp/context');

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

ES6-style import

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

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

example.ts

import {get, run} from '/lib/xp/context';

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

Keywords

FAQs

Last updated on 01 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc