Interface Module

Interface describing the shape of a Module while being aligned with well-known package.json fields. This interface additionally specifies optional sgrudDependencies and webDependencies mappings, which both are used by the Kernel to determine SGRUD module dependencies and runtime dependencies.

Example

An exemplary Module definition:

import { type Kernel } from '@sgrud/core';

const module: Kernel.Module = {
  name: 'module',
  version: '0.0.0',
  exports: './module.exports.js',
  unpkg: './module.unpkg.js',
  sgrudDependencies: {
    sgrudDependency: '^0.0.1'
  },
  webDependencies: {
    webDependency: {
      exports: {
        webDependency: './webDependency.exports.js'
      },
      unpkg: [
        './webDependency.unpkg.js'
      ]
    }
  }
};
interface Module {
    digest?: Record<string, Digest>;
    exports?: string;
    name: string;
    sgrudDependencies?: Record<string, string>;
    unpkg?: string;
    version: string;
    webDependencies?: Record<string, WebDependency>;
}

Properties

digest? exports? name sgrudDependencies? unpkg? version webDependencies?

Properties

Optional Readonly digest

digest?: Record<string, Digest>

Optional bundle Digests. If hashes are supplied, they will be used to verify the Subresource Integrity of the respective bundles.

Optional Readonly exports

exports?: string

Optional ESM entry point.

Readonly name

name: string

The name of the Module.

Optional Readonly sgrudDependencies

sgrudDependencies?: Record<string, string>

Optional SGRUD Module dependencies.

Optional Readonly unpkg

unpkg?: string

Optional UMD entry point.

Readonly version

version: string

The Module version, formatted as according to the semver specifications.

Optional Readonly webDependencies

webDependencies?: Record<string, WebDependency>

Optional WebDependency mapping.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc