From bbdf5659df9da082125b1422cda114d34d0c5c27 Mon Sep 17 00:00:00 2001 From: Jaco Date: Sat, 17 Jul 2021 09:49:30 +0300 Subject: [PATCH] Add isCompact (#1061) --- CHANGELOG.md | 7 +++++++ packages/util/src/is/compact.ts | 21 +++++++++++++++++++++ packages/util/src/is/index.ts | 1 + 3 files changed, 29 insertions(+) create mode 100644 packages/util/src/is/compact.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 01c260c96..a052b6f91 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # CHANGELOG +## master + +Changes: + +- Added `isCompact` utility for check on compact-like types + + ## 7.0.1 Jul 11, 2021 - **Breaking change** The `@polkadot/x-rxjs` package has been removed. In `rxjs` 7.2.0 the compatibility issues at the base layer has been solved. diff --git a/packages/util/src/is/compact.ts b/packages/util/src/is/compact.ts new file mode 100644 index 000000000..08b5955d3 --- /dev/null +++ b/packages/util/src/is/compact.ts @@ -0,0 +1,21 @@ +// Copyright 2017-2021 @polkadot/util authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +import type { BN } from '../bn/bn'; + +import { isFunction } from './function'; + +interface Compact { + toBigInt (): bigint; + toBn (): BN; + toNumber (): number; + unwrap (): T; +} + +/** + * @name isCompact + * @summary Tests for SCALE-Compact-like object instance. + */ +export function isCompact (value: unknown): value is Compact { + return isFunction((value as Compact).toBigInt) && isFunction((value as Compact).toBn) && isFunction((value as Compact).toNumber) && isFunction((value as Compact).unwrap); +} diff --git a/packages/util/src/is/index.ts b/packages/util/src/is/index.ts index d2687ad20..a47d962fb 100644 --- a/packages/util/src/is/index.ts +++ b/packages/util/src/is/index.ts @@ -10,6 +10,7 @@ export { isBn } from './bn'; export { isBuffer } from './buffer'; export { isBoolean } from './boolean'; export { isChildClass } from './childClass'; +export { isCompact } from './compact'; export { isError } from './error'; export { isFunction } from './function'; export { isHex } from './hex';