Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 824 Bytes

README.md

File metadata and controls

34 lines (28 loc) · 824 Bytes
Raw

substrate

Common types, interfaces and abstracts

Install

npm i @qiwi/substrate -D
yarn i @qiwi/substrate --dev

Usage

import { IStringMap } from '@qiwi/substrate'

const foo: IStringMap = {
  bar: 'baz',
  qux: 'quux'
}

Contract

Naming

Upper-camel-case with prefixes I, T and A.

  • IFoo — Foo interface
  • TBar — Bar type
  • ABaz — Baz abstract
Versioning

Type changes without backward compatibility should be complemented by a version suffix Vx, where x ∈ ℕ.

  • IFooV1 — The first version of Foo interface
  • TBarV2 — Bar type version 2

Docs