@tai-kun/surrealdb/src/data-types/encodable/bound-included.ts

The SurrealDB SDK for JavaScript

import {
  BoundIncluded as Base,
  type BoundIncludedSource,
} from "@tai-kun/surrealdb/decodeonly-datatypes";
import { toSurql } from "@tai-kun/surrealdb/utils";
import { CBOR_TAG_BOUND_INCLUDED, type Encodable } from "./spec";

export type * from "../decode-only/bound-included";

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/data/bound-included)
 * @experimental
 */
export default class BoundIncluded<
  TValue extends BoundIncludedSource = BoundIncludedSource,
> extends Base<TValue> implements Encodable {
  override toString(): string {
    return String(this.value);
  }

  toCBOR(): [
    tag: typeof CBOR_TAG_BOUND_INCLUDED,
    value: TValue,
  ] {
    return [
      CBOR_TAG_BOUND_INCLUDED,
      this.value,
    ];
  }

  toJSON(): string {
    return this.toString();
  }

  toSurql(): string {
    return toSurql(this.value);
  }

  toPlainObject(): {
    value: TValue;
  } {
    return {
      value: this.value,
    };
  }
}