Class default

constructor

• new default(
      _hostname: string,
      timezoneOffset?: (moment: Moment) => number,
      verify?: boolean,
  ): default

  Parameters

  • _hostname: string
  • timezoneOffset: (moment: Moment) => number = ...
  • verify: boolean = true

  Returns default

_metadata

Readonlyhostname

Readonlyprotocol

ReadonlytimezoneOffsetFunc

Readonlyverify

dateFormat

• get dateFormat(): string

  FileMaker host date format converted to Moment-compatible tokens.

  Returns string

metadata

• get metadata(): {
      productInfo: {
          buildDate?: Date;
          dateFormat: string;
          name: string;
          timeFormat: string;
          timeStampFormat: string;
          version?: string;
      };
  }

  Returns {
      productInfo: {
          buildDate?: Date;
          dateFormat: string;
          name: string;
          timeFormat: string;
          timeStampFormat: string;
          version?: string;
      };
  }

timeFormat

• get timeFormat(): string

  FileMaker host time format.

  Returns string

timeStampFormat

• get timeStampFormat(): string

  FileMaker host timestamp format converted to Moment-compatible tokens.

  Returns string

database

• database<T extends DatabaseStructure>(
      data: databaseOptionsWithExternalSources,
  ): Database<T>

  Creates a new database connection with the specified options.

  Type Parameters

  • T extends DatabaseStructure

    The type of the database structure.

  Parameters

  • data: databaseOptionsWithExternalSources

    The options for the database, including external sources.

  Returns Database<T>

  A new Database instance.

getMetadata

• getMetadata(): Promise<
      {
          productInfo: {
              buildDate?: Date;
              dateFormat: string;
              name: string;
              timeFormat: string;
              timeStampFormat: string;
              version?: string;
          };
      },
  >

  Fetch and cache FileMaker host product metadata.

  Returns Promise<
      {
          productInfo: {
              buildDate?: Date;
              dateFormat: string;
              name: string;
              timeFormat: string;
              timeStampFormat: string;
              version?: string;
          };
      },
  >

listDatabases

• listDatabases(
      credentials?:
          | loginOptionsOAuth
          | loginOptionsFileMaker
          | loginOptionsClaris,
  ): Promise<{ name: string }[]>

  Retrieves a list of databases from the FileMaker Server.

  Parameters

  • Optionalcredentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris

    Optional credentials required for authentication.

  Returns Promise<{ name: string }[]>

  A promise that resolves to an array of database objects if successful.

  Throws

  If the request to the FileMaker Server fails or if the response contains an error.