polkadot-js/api

View on GitHub
packages/types/src/codec/Int.ts

Summary

Maintainability
A
3 hrs
Test Coverage
// Copyright 2017-2020 @polkadot/types authors & contributors
// SPDX-License-Identifier: Apache-2.0

import { AnyNumber, Constructor, Registry } from '../types';
import { UIntBitLength } from './types';

import { AbstractInt } from './AbstractInt';

/**
 * @name Int
 * @description
 * A generic signed integer codec. For Substrate all numbers are Little Endian encoded,
 * this handles the encoding and decoding of those numbers. Upon construction
 * the bitLength is provided and any additional use keeps the number to this
 * length. This extends `BN`, so all methods available on a normal `BN` object
 * is available here.
 * @noInheritDoc
 */
export class Int extends AbstractInt {
  constructor (registry: Registry, value: AnyNumber = 0, bitLength?: UIntBitLength) {
    super(registry, value, bitLength, true);
  }

  public static with (bitLength: UIntBitLength, typeName?: string): Constructor<Int> {
    return class extends Int {
      constructor (registry: Registry, value?: AnyNumber) {
        super(registry, value, bitLength);
      }

      public toRawType (): string {
        return typeName || super.toRawType();
      }
    };
  }
}