decimal-numbering

number hierarchical document parts like "Section 1.5.3"


Keywords
abstract-numbering, documents, enumeration, heading, lists, numbering, outline
License
BlueOak-1.0.0
Install
npm install decimal-numbering@4.0.0

Documentation

decimal-numbering

number hierarchical document parts like "Section 1.5.3"

decimal-numbering is part of the abstract-numbering family of packages.

var decimal = require('decimal-numbering')
var assert = require('assert')

assert.deepStrictEqual(
  decimal([
    {
      series: { number: 1, of: 2 },
      element: { number: 1, of: 1 }
    }
  ]),
  'Section\u00a0A-1'
)

assert.deepStrictEqual(
  decimal([
    {
      series: { number: 28, of: 28 },
      element: { number: 1, of: 1 }
    }
  ]),
  'Section\u00a0AB-1'
)

assert.deepStrictEqual(
  decimal([
    {
      series: { number: 1, of: 1 },
      element: { number: 1, of: 1 }
    },
    {
      series: { number: 1, of: 1 },
      element: { number: 1, of: 1 }
    },
    {
      series: { number: 1, of: 1 },
      element: { number: 1, of: 1 }
    },
    {
      series: { number: 1, of: 1 },
      element: { number: 1, of: 1 }
    }
  ]),
  'Section\u00a01.1.1.1'
)

assert.deepStrictEqual(
  decimal(
    [
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      },
      {
        series: { number: 1, of: 1 },
        element: { number: 1, of: 1 }
      }
    ],
    true
  ),
  '1.1.1.1.'
)