Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@enonic-types/lib-content

Package Overview
Dependencies
Maintainers
3
Versions
41
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@enonic-types/lib-content

Type definitions for lib-content.

  • 7.12.0-RC4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
356
decreased by-50.35%
Maintainers
3
Weekly downloads
 
Created
Source

Enonic XP lib-content TS types

TypeScript definitions for lib-content library of Enonic XP

Install

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

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, query, getChildren} = require('/lib/xp/content');

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/content": ["node_modules/@enonic-types/lib-content"]
    }
  }
}

example.ts

import {get, query, getChildren} from '/lib/xp/content';

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

Additional types

Note that not all types are available for import, but can easily be retrieved from the Content:

import type {Content} from '/lib/xp/content';

type Attachments = Content['attachments'];

type ContentInheritType = Content['inherit'];

type Workflow = Content['workflow'];

Keywords

FAQs

Package last updated on 08 Mar 2023

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc