5.0.0-beta.1 · Published beta · b06750c5. Published on npm. Match your installed version.

Marionette Utility Exports#

Marionette exports the standalone utilities and package facts that do not require a framework instance. Common framework conventions such as bindEvents, getOption, mergeOptions, normalizeMethods, and triggerMethod are documented as instance methods.

The v4 target-first exports also adapted these conventions to arbitrary plain objects. That adapter is not part of v5. Import reusable helpers from @mnjs/utils when a plain component needs them; extend MnObject when it needs Marionette's initialization and cleanup lifecycle. Do not borrow a framework prototype solely to obtain a helper.

Documentation Index#

• extend
• VERSION

extend#

extend is Marionette's owned, standalone implementation of its classic pseudo-class extension convention. Assign it to a constructor, then call it as a method so that constructor is the parent. Marionette's extendable classes already expose this method.

import { extend } from 'marionette';

function Service(name) {
  this.name = name;
}

Service.extend = extend;

const SpecialService = Service.extend({
  label() {
    return `special:${this.name}`;
  }
}, {
  kind: 'special'
});

const service = new SpecialService('api');

export { Service, SpecialService, extend, service };

The child inherits the parent's prototype and static properties. Prototype properties are supplied by the first argument and optional static properties by the second. See the v4 compatibility ledger for the v5 input-copying boundary.

VERSION#

VERSION is the installed Marionette package version. Marionette also uses it when constructing versioned diagnostic documentation URLs; exporting it does not imply that a corresponding website deployment is available.

import { VERSION } from 'marionette';

export { VERSION };