Class JarvisExtDB

constructor

• new JarvisExtDB(extId: number): db.JarvisExtDB

• Parameters

  • extId: number

  Returns db.JarvisExtDB

extId

add

• add(
      data: { data: string; dataType?: string; searchText?: string },
  ): Promise<void>

• Parameters

  • data: { data: string; dataType?: string; searchText?: string }

  Returns Promise<void>

delete

• delete(dataId: number): Promise<void>

• Parameters

  • dataId: number

  Returns Promise<void>

deleteAll

• deleteAll(): Promise<void>

• Delete all data of this extension.

  Returns Promise<void>

retrieveAll

• retrieveAll(
      options: { fields?: ("data" | "search_text")[] },
  ): Promise<
      {
          createdAt: Date;
          data?: string;
          dataId: number;
          dataType: string;
          extId: number;
          searchText?: string;
          updatedAt: Date;
      }[],
  >

• Retrieve all data of this extension. Use search() method for more advanced search.

  Parameters

  • options: { fields?: ("data" | "search_text")[] }

    optional fields to retrieve. By default, data and searchText are not returned.

  Returns Promise<
      {
          createdAt: Date;
          data?: string;
          dataId: number;
          dataType: string;
          extId: number;
          searchText?: string;
          updatedAt: Date;
      }[],
  >

retrieveAllByType

• retrieveAllByType(
      dataType: string,
  ): Promise<
      {
          createdAt: Date;
          data?: string;
          dataId: number;
          dataType: string;
          extId: number;
          searchText?: string;
          updatedAt: Date;
      }[],
  >

• Retrieve all data of this extension by type. Use search() method for more advanced search.

  Parameters

  • dataType: string

  Returns Promise<
      {
          createdAt: Date;
          data?: string;
          dataId: number;
          dataType: string;
          extId: number;
          searchText?: string;
          updatedAt: Date;
      }[],
  >

search

• search(
      searchParams: {
          afterCreatedAt?: Date;
          beforeCreatedAt?: Date;
          dataId?: number;
          dataType?: string;
          fields?: ("data" | "search_text")[];
          limit?: number;
          orderByCreatedAt?: EnumValues<typeof SQLSortOrderEnum>;
          orderByUpdatedAt?: EnumValues<typeof SQLSortOrderEnum>;
          searchMode?: EnumValues<typeof SearchModeEnum>;
          searchText?: string;
      },
  ): Promise<
      {
          createdAt: Date;
          data?: string;
          dataId: number;
          dataType: string;
          extId: number;
          searchText?: string;
          updatedAt: Date;
      }[],
  >

• Parameters

  • searchParams: {
        afterCreatedAt?: Date;
        beforeCreatedAt?: Date;
        dataId?: number;
        dataType?: string;
        fields?: ("data" | "search_text")[];
        limit?: number;
        orderByCreatedAt?: EnumValues<typeof SQLSortOrderEnum>;
        orderByUpdatedAt?: EnumValues<typeof SQLSortOrderEnum>;
        searchMode?: EnumValues<typeof SearchModeEnum>;
        searchText?: string;
    }

  Returns Promise<
      {
          createdAt: Date;
          data?: string;
          dataId: number;
          dataType: string;
          extId: number;
          searchText?: string;
          updatedAt: Date;
      }[],
  >

update

• update(
      data: { data: string; dataId: number; searchText?: string },
  ): Promise<void>

• Update data and searchText of this extension.

  Parameters

  • data: { data: string; dataId: number; searchText?: string }

  Returns Promise<void>