Class Field<T>

constructor

• new Field<T extends FieldValue>(
      record: Parentable,
      id: string,
      originalContents: T,
  ): Field<T>

  Type Parameters

  • T extends FieldValue

    The type of the field value.

  Parameters

  • record: Parentable
  • id: string
  • originalContents: T

  Returns Field<T>

id

parent

StaticfirstContainerDownload

edited

• get edited(): boolean

  true if this field has changed since it was last loaded or saved.

  Returns boolean

metadata

• get metadata(): {
      autoEnter: boolean;
      displayType: | "calendar"
      | "editText"
      | "popupList"
      | "checkBox"
      | "radioButtons"
      | "selectionList"
      | "secureText";
      fourDigitYear: boolean;
      global: boolean;
      maxCharacters: number;
      maxRepeat: number;
      name: string;
      notEmpty: boolean;
      numeric: boolean;
      repetitionEnd: number;
      repetitionStart: number;
      result: "number"
      | "time"
      | "container"
      | "text"
      | "date"
      | "timeStamp";
      timeOfDay: boolean;
      type: "normal" | "summary" | "calculation";
      valueList?: string;
  }

  Returns the FileMaker metadata for this field.

  Returns {
      autoEnter: boolean;
      displayType:
          | "calendar"
          | "editText"
          | "popupList"
          | "checkBox"
          | "radioButtons"
          | "selectionList"
          | "secureText";
      fourDigitYear: boolean;
      global: boolean;
      maxCharacters: number;
      maxRepeat: number;
      name: string;
      notEmpty: boolean;
      numeric: boolean;
      repetitionEnd: number;
      repetitionStart: number;
      result: "number"
      | "time"
      | "container"
      | "text"
      | "date"
      | "timeStamp";
      timeOfDay: boolean;
      type: "normal" | "summary" | "calculation";
      valueList?: string;
  }

string

• get string(): string

  Returns this field value as a string. Throws if the value is not a string.

  Returns string

value

• get value(): T | null

  Gets or sets the current field value.

  Returns T | null

• set value(value: T): void

  Parameters

  • value: T

  Returns void

arrayBuffer

• arrayBuffer(): Promise<{ data: ArrayBuffer; mime: string }>

  Downloads the full container contents into memory.

  Returns Promise<{ data: ArrayBuffer; mime: string }>

set

• set(content: T | null): void

  Sets the value of the field.

  Parameters

  • content: T | null

    The new content value to be set. Can be either the type T or null.

  Returns void

  Throws

  Cannot set container value using set(). Use upload() instead, if the result is a 'container'.

stream

• stream(): Promise<{ data: Readable; mime: string }>

  Returns Promise<{ data: Readable; mime: string }>

updateOriginalContents

• updateOriginalContents(): void

  Resets the 'edited' state of this field, without changing its value

  Returns void

upload

• upload(file: File): Promise<void>

  Uploads a file to the container field.

  Parameters

  • file: File

    The file content as a buffer.

  Returns Promise<void>

  • A promise that resolves when the file is successfully uploaded.

  Throws

  • Cannot upload a file to the field if it's not a container field.

  Throws

  • Upload failed with HTTP error.

webStream

• webStream(options: StreamOptions): Promise<Response>

  Returns the container download as a Web Response.

  Parameters

  • options: StreamOptions

  Returns Promise<Response>