Files
common/packages/util/src/is/compact.ts
T
2021-11-18 09:57:26 +02:00

29 lines
656 B
TypeScript

// Copyright 2017-2021 @polkadot/util authors & contributors
// SPDX-License-Identifier: Apache-2.0
import type { BN } from '../bn/bn';
import { isFunction } from './function';
import { isObject } from './object';
interface Compact<T> {
toBigInt (): bigint;
toBn (): BN;
toNumber (): number;
unwrap (): T;
}
/**
* @name isCompact
* @summary Tests for SCALE-Compact-like object instance.
*/
export function isCompact <T> (value?: unknown): value is Compact<T> {
return (
isObject<Compact<T>>(value) &&
isFunction(value.toBigInt) &&
isFunction(value.toBn) &&
isFunction(value.toNumber) &&
isFunction(value.unwrap)
);
}