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

The SurrealDB SDK for JavaScript

import {
  Table as Base,
  type TableSource,
} from "@tai-kun/surrealdb/decodeonly-datatypes";
import { escapeIdent } from "@tai-kun/surrealdb/utils";
import { CBOR_TAG_TABLE, type Encodable } from "./spec";

export type * from "../decode-only/table";

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/data/table)
 */
export default class Table<TName extends TableSource = TableSource>
  extends Base<TName>
  implements Encodable
{
  override valueOf(): TName {
    return this.name;
  }

  override toString(): TName {
    return this.name;
  }

  [Symbol.toPrimitive](hint: "default" | "string"): TName;
  [Symbol.toPrimitive](hint: string): TName;
  [Symbol.toPrimitive](hint: string): TName {
    switch (hint) {
      case "string":
      case "default":
        return this.name;

      default:
        throw TypeError("Invalid hint: " + String(hint));
    }
  }

  toCBOR(): [tag: typeof CBOR_TAG_TABLE, value: TName] {
    return [CBOR_TAG_TABLE, this.name];
  }

  toJSON(): TName {
    return this.name;
  }

  toSurql(): string {
    // SurrealDB では String を escape_ident でエスケープしている:
    // https://github.com/surrealdb/surrealdb/blob/v2.0.1/core/src/sql/table.rs#L78
    return escapeIdent(this.name);
  }

  toPlainObject(): {
    name: string;
  } {
    return {
      name: this.name,
    };
  }
}