Class Robotoff

Constructors

constructor

Properties

fetch raw

Methods

annotate insightDetail loadLogo questionsByProductCode

Constructors

constructor

  • new Robotoff(fetch): Robotoff

  • Parameters

    • fetch: ((input, init?) => Promise<Response>)
        • (input, init?): Promise<Response>

        • MDN Reference

          Parameters

          • input: RequestInfo | URL
          • Optional init: RequestInit

          Returns Promise<Response>

    Returns Robotoff

Properties

Private Readonly fetch

fetch: ((input, init?) => Promise<Response>)

The fetch function used for every request

Type declaration

    • (input, init?): Promise<Response>

    • The fetch function used for every request

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

Private Readonly raw

raw: {
    DELETE<P>(url, ...init): Promise<FetchResponse<"delete" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "delete"]
        : unknown>>;
    GET<P>(url, ...init): Promise<FetchResponse<"get" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "get"]
        : unknown>>;
    HEAD<P>(url, ...init): Promise<FetchResponse<"head" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "head"]
        : unknown>>;
    OPTIONS<P>(url, ...init): Promise<FetchResponse<"options" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "options"]
        : unknown>>;
    PATCH<P>(url, ...init): Promise<FetchResponse<"patch" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "patch"]
        : unknown>>;
    POST<P>(url, ...init): Promise<FetchResponse<"post" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "post"]
        : unknown>>;
    PUT<P>(url, ...init): Promise<FetchResponse<"put" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "put"]
        : unknown>>;
    TRACE<P>(url, ...init): Promise<FetchResponse<"trace" extends keyof paths[P]
        ? paths[P][keyof paths[P] & "trace"]
        : unknown>>;
}

The raw openapi-fetch client is used for every request exposed by the openapi schema

Type declaration

  • DELETE:function
    • DELETE<P>(url, ...init): Promise<FetchResponse<"delete" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "delete"]
          : unknown>>

    • Call a DELETE endpoint

      Type Parameters

      • P extends never

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "delete">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "delete">>?]
            : [FetchOptions<FilterKeys<paths[P], "delete">>]

      Returns Promise<FetchResponse<"delete" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "delete"]
          : unknown>>

  • GET:function
    • GET<P>(url, ...init): Promise<FetchResponse<"get" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "get"]
          : unknown>>

    • Call a GET endpoint

      Type Parameters

      • P extends PathsWithMethod<paths, "get">

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "get">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "get">>?]
            : [FetchOptions<FilterKeys<paths[P], "get">>]

      Returns Promise<FetchResponse<"get" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "get"]
          : unknown>>

  • HEAD:function
    • HEAD<P>(url, ...init): Promise<FetchResponse<"head" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "head"]
          : unknown>>

    • Call a HEAD endpoint

      Type Parameters

      • P extends never

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "head">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "head">>?]
            : [FetchOptions<FilterKeys<paths[P], "head">>]

      Returns Promise<FetchResponse<"head" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "head"]
          : unknown>>

  • OPTIONS:function
    • OPTIONS<P>(url, ...init): Promise<FetchResponse<"options" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "options"]
          : unknown>>

    • Call a OPTIONS endpoint

      Type Parameters

      • P extends never

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "options">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "options">>?]
            : [FetchOptions<FilterKeys<paths[P], "options">>]

      Returns Promise<FetchResponse<"options" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "options"]
          : unknown>>

  • PATCH:function
    • PATCH<P>(url, ...init): Promise<FetchResponse<"patch" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "patch"]
          : unknown>>

    • Call a PATCH endpoint

      Type Parameters

      • P extends never

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "patch">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "patch">>?]
            : [FetchOptions<FilterKeys<paths[P], "patch">>]

      Returns Promise<FetchResponse<"patch" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "patch"]
          : unknown>>

  • POST:function
    • POST<P>(url, ...init): Promise<FetchResponse<"post" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "post"]
          : unknown>>

    • Call a POST endpoint

      Type Parameters

      • P extends PathsWithMethod<paths, "post">

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "post">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "post">>?]
            : [FetchOptions<FilterKeys<paths[P], "post">>]

      Returns Promise<FetchResponse<"post" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "post"]
          : unknown>>

  • PUT:function
    • PUT<P>(url, ...init): Promise<FetchResponse<"put" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "put"]
          : unknown>>

    • Call a PUT endpoint

      Type Parameters

      • P extends never

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "put">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "put">>?]
            : [FetchOptions<FilterKeys<paths[P], "put">>]

      Returns Promise<FetchResponse<"put" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "put"]
          : unknown>>

  • TRACE:function
    • TRACE<P>(url, ...init): Promise<FetchResponse<"trace" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "trace"]
          : unknown>>

    • Call a TRACE endpoint

      Type Parameters

      • P extends never

      Parameters

      • url: P
      • Rest ...init: HasRequiredKeys<FetchOptions<FilterKeys<paths[P], "trace">>> extends never
            ? [FetchOptions<FilterKeys<paths[P], "trace">>?]
            : [FetchOptions<FilterKeys<paths[P], "trace">>]

      Returns Promise<FetchResponse<"trace" extends keyof paths[P]
          ? paths[P][keyof paths[P] & "trace"]
          : unknown>>

Methods

annotate

  • annotate(body): Promise<FetchResponse<{
        requestBody: {
            content: {
                application/x-www-form-urlencoded: {
                    annotation: 0 | 1 | -1;
                    insight_id: string;
                    update?: 0 | 1;
                };
            };
        };
        responses: {
            200: {
                content: {};
            };
        };
    }>>

  • Parameters

    • body: {
          annotation: 0 | 1 | -1;
          insight_id: string;
          update?: 0 | 1;
      }
      • annotation: 0 | 1 | -1

        Description

        Annotation of the prediction: 1 to accept the prediction, 0 to refuse it, and -1 for skip

      • insight_id: string

        Description

        ID of the insight

      • Optional update?: 0 | 1

        Description

        Send the update to Openfoodfacts if update=1, don't send the update otherwise. This parameter is useful if the update is performed client-side

        Default

        1
        @enum {integer}

    Returns Promise<FetchResponse<{
        requestBody: {
            content: {
                application/x-www-form-urlencoded: {
                    annotation: 0 | 1 | -1;
                    insight_id: string;
                    update?: 0 | 1;
                };
            };
        };
        responses: {
            200: {
                content: {};
            };
        };
    }>>

insightDetail

  • insightDetail(id): Promise<undefined>

  • Parameters

    • id: string

    Returns Promise<undefined>

loadLogo

  • loadLogo(logoId): Promise<undefined>

  • Parameters

    • logoId: string

    Returns Promise<undefined>

questionsByProductCode

  • questionsByProductCode(code): Promise<undefined | {
        questions?: Record<string, never>[];
        status?: "no_questions" | "found";
    }>

  • Parameters

    • code: number

    Returns Promise<undefined | {
        questions?: Record<string, never>[];
        status?: "no_questions" | "found";
    }>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc