clean-jsdoc-theme API

forge/contracts

Source: contracts.js:8

Contracts & helpers — the interfaces, mixin, and namespace that the concrete classes build on.


Instance Methods

slug(input) -> string

Shorthand alias for text.slugify.

Alias: slug

Parameters

  • input (string) — The string to slugify.

Returns

  • string — A lowercase, hyphenated slug.

Other

Store

A minimal key/value store contract. Cache implements it.

Serializable

Anything that can be turned into a JSON-safe snapshot.

Timestamped

Adds created/updated timestamps to whatever it is mixed into.

Example

CODE
Object.assign(MyClass.prototype, Timestamped);

Record

Mixes: Timestamped

A timestamped record — demonstrates @mixes.

Parameters

  • data (Object) — Arbitrary record fields.

text

A grab-bag of pure string utilities.

String helpers used across Forge.