npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@enonic-types/global

v7.14.4

Published

Global variables and functions type definition.

Downloads

3,410

Readme

Enonic XP global TS types

TypeScript definitions for global variables of Enonic XP

Install

npm i --save-dev @enonic-types/global

Use

Add the corresponding types to your tsconfig.json file that is used for application's server-side TypeScript code:

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

After that, all the global XP variables will be typed.

Import functions, such as require, will return typed objects if the corresponding types for imported libraries are also added to your tsconfig.json.

Configuration

Require

To add support for type resolution for the custom libraries via require, you can redeclare the XpLibraries interface in global scope, which will lead to declaration merging:

declare global {
    interface XpLibraries {
        '/lib/custom/mylib': typeof import('./mylib');
    }
}

Other imports

If you want to use custom import functions, like __non_webpack_require__ with Webpack, just use global XpRequire type for this:

declare const __non_webpack_require__: XpRequire;

Beans

To create a new bean, a __.newBean() function must be used. Making it return a proper type can be done in two ways. Say you have created an interface for that been somewhere in your project:

interface SomeHelper {
    help(text: string): void;
}

Option 1

You can pass the type argument explicitly. This option is a bit cleaner.

const helper = __.newBean<SomeHelper>('com.me.project.SomeHelper');

Option 2

Or you can map the bean name to bean interface. It may be a preferable way to do it, if the bean is used across multiple files:

declare global {
    interface XpBeans {
        'com.me.project.SomeHelper': SomeHelper;
    }
}

const helper = __.newBean('com.me.project.SomeHelper');