@polkadot/types-codec 6.12.2-2

package/native/Raw.cjs

@@ -0,0 +1,192 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Raw = void 0;
+
+var _util = require("@polkadot/util");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name Raw
+ * @description
+ * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
+ * from other implementations where it will consume the full Uint8Array as passed to it.
+ * As such it is meant to be subclassed where the wrapper takes care of the
+ * actual lengths instead of used directly.
+ * @noInheritDoc
+ */
+class Raw extends Uint8Array {
+  constructor(registry, value, initialU8aLength) {
+    super((0, _util.u8aToU8a)(value));
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    this.initialU8aLength = void 0;
+    this.registry = registry;
+    this.initialU8aLength = initialU8aLength;
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return this.length;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Returns true if the wrapped value contains only ASCII printable characters
+   */
+
+
+  get isAscii() {
+    return (0, _util.isAscii)(this);
+  }
+  /**
+   * @description Returns true if the type wraps an empty/default all-0 value
+   */
+
+
+  get isEmpty() {
+    return !this.length || (0, _util.isUndefined)(this.find(b => !!b));
+  }
+  /**
+   * @description Returns true if the wrapped value contains only utf8 characters
+   */
+
+
+  get isUtf8() {
+    return (0, _util.isUtf8)(this);
+  }
+  /**
+   * @description The length of the value
+   */
+
+
+  get length() {
+    // only included here since we ignore inherited docs
+    return super.length;
+  }
+  /**
+   * @description Returns the number of bits in the value
+   */
+
+
+  bitLength() {
+    return this.length * 8;
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    if (other instanceof Uint8Array) {
+      return this.length === other.length && !this.some((b, index) => b !== other[index]);
+    }
+
+    return this.eq((0, _util.u8aToU8a)(other));
+  }
+  /**
+   * @description Create a new slice from the actual buffer. (compat)
+   * @param start The position to start at
+   * @param end The position to end at
+   */
+
+
+  slice(start, end) {
+    // Like subarray below, we have to follow this approach since we are extending the TypeArray.
+    // This happens especially when it comes to further extensions, the length may be an override
+    return Uint8Array.from(this).slice(start, end);
+  }
+  /**
+   * @description Create a new subarray from the actual buffer. (compat)
+   * @param begin The position to start at
+   * @param end The position to end at
+   */
+
+
+  subarray(begin, end) {
+    return Uint8Array.from(this).subarray(begin, end);
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex() {
+    return (0, _util.u8aToHex)(this);
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman() {
+    if (this.isAscii) {
+      const text = this.toUtf8(); // ensure we didn't end up with multibyte codepoints
+
+      if ((0, _util.isAscii)(text)) {
+        return text;
+      }
+    }
+
+    return this.toJSON();
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return this.toHex();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Raw';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return this.toHex();
+  }
+  /**
+   * @description Encodes the value as a Uint8Array as per the SCALE specifications
+   * @param isBare true when the value has none of the type-specific prefixes (internal)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    return Uint8Array.from(this);
+  }
+  /**
+   * @description Returns the wrapped data as a UTF-8 string
+   */
+
+
+  toUtf8() {
+    (0, _util.assert)(this.isUtf8, 'The character sequence is not a valid Utf8 string');
+    return (0, _util.u8aToString)(this);
+  }
+
+}
+
+exports.Raw = Raw;

package/native/Raw.d.ts

@@ -0,0 +1,90 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyJson, AnyU8a, CodecRegistry, IU8a } from '../types';
+/**
+ * @name Raw
+ * @description
+ * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
+ * from other implementations where it will consume the full Uint8Array as passed to it.
+ * As such it is meant to be subclassed where the wrapper takes care of the
+ * actual lengths instead of used directly.
+ * @noInheritDoc
+ */
+export declare class Raw extends Uint8Array implements IU8a {
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    readonly initialU8aLength?: number;
+    constructor(registry: CodecRegistry, value?: AnyU8a, initialU8aLength?: number);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Returns true if the wrapped value contains only ASCII printable characters
+     */
+    get isAscii(): boolean;
+    /**
+     * @description Returns true if the type wraps an empty/default all-0 value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Returns true if the wrapped value contains only utf8 characters
+     */
+    get isUtf8(): boolean;
+    /**
+     * @description The length of the value
+     */
+    get length(): number;
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength(): number;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @description Create a new slice from the actual buffer. (compat)
+     * @param start The position to start at
+     * @param end The position to end at
+     */
+    slice(start?: number, end?: number): Uint8Array;
+    /**
+     * @description Create a new subarray from the actual buffer. (compat)
+     * @param begin The position to start at
+     * @param end The position to end at
+     */
+    subarray(begin?: number, end?: number): Uint8Array;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): AnyJson;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): string;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+    /**
+     * @description Returns the wrapped data as a UTF-8 string
+     */
+    toUtf8(): string;
+}

package/native/Raw.js

@@ -0,0 +1,182 @@
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { assert, isAscii, isUndefined, isUtf8, u8aToHex, u8aToString, u8aToU8a } from '@polkadot/util';
+/**
+ * @name Raw
+ * @description
+ * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
+ * from other implementations where it will consume the full Uint8Array as passed to it.
+ * As such it is meant to be subclassed where the wrapper takes care of the
+ * actual lengths instead of used directly.
+ * @noInheritDoc
+ */
+
+export class Raw extends Uint8Array {
+  constructor(registry, value, initialU8aLength) {
+    super(u8aToU8a(value));
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    this.initialU8aLength = void 0;
+    this.registry = registry;
+    this.initialU8aLength = initialU8aLength;
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return this.length;
+  }
+  /**
+   * @description returns a hash of the contents
+   */
+
+
+  get hash() {
+    return this.registry.hash(this.toU8a());
+  }
+  /**
+   * @description Returns true if the wrapped value contains only ASCII printable characters
+   */
+
+
+  get isAscii() {
+    return isAscii(this);
+  }
+  /**
+   * @description Returns true if the type wraps an empty/default all-0 value
+   */
+
+
+  get isEmpty() {
+    return !this.length || isUndefined(this.find(b => !!b));
+  }
+  /**
+   * @description Returns true if the wrapped value contains only utf8 characters
+   */
+
+
+  get isUtf8() {
+    return isUtf8(this);
+  }
+  /**
+   * @description The length of the value
+   */
+
+
+  get length() {
+    // only included here since we ignore inherited docs
+    return super.length;
+  }
+  /**
+   * @description Returns the number of bits in the value
+   */
+
+
+  bitLength() {
+    return this.length * 8;
+  }
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+
+
+  eq(other) {
+    if (other instanceof Uint8Array) {
+      return this.length === other.length && !this.some((b, index) => b !== other[index]);
+    }
+
+    return this.eq(u8aToU8a(other));
+  }
+  /**
+   * @description Create a new slice from the actual buffer. (compat)
+   * @param start The position to start at
+   * @param end The position to end at
+   */
+
+
+  slice(start, end) {
+    // Like subarray below, we have to follow this approach since we are extending the TypeArray.
+    // This happens especially when it comes to further extensions, the length may be an override
+    return Uint8Array.from(this).slice(start, end);
+  }
+  /**
+   * @description Create a new subarray from the actual buffer. (compat)
+   * @param begin The position to start at
+   * @param end The position to end at
+   */
+
+
+  subarray(begin, end) {
+    return Uint8Array.from(this).subarray(begin, end);
+  }
+  /**
+   * @description Returns a hex string representation of the value
+   */
+
+
+  toHex() {
+    return u8aToHex(this);
+  }
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+
+
+  toHuman() {
+    if (this.isAscii) {
+      const text = this.toUtf8(); // ensure we didn't end up with multibyte codepoints
+
+      if (isAscii(text)) {
+        return text;
+      }
+    }
+
+    return this.toJSON();
+  }
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+
+
+  toJSON() {
+    return this.toHex();
+  }
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Raw';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return this.toHex();
+  }
+  /**
+   * @description Encodes the value as a Uint8Array as per the SCALE specifications
+   * @param isBare true when the value has none of the type-specific prefixes (internal)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+
+  toU8a(isBare) {
+    return Uint8Array.from(this);
+  }
+  /**
+   * @description Returns the wrapped data as a UTF-8 string
+   */
+
+
+  toUtf8() {
+    assert(this.isUtf8, 'The character sequence is not a valid Utf8 string');
+    return u8aToString(this);
+  }
+
+}