• Parameters

    • connectionOptions: {
          apiUrl: string;
          headers: Object;
      }
      • apiUrl: string

        Target annotation database API URL

      • headers: Object

        Headers responsible for authenticating the request and the Hypothes.is Accept header

    • query: {
          _separate_replies?: boolean;
          any?: string;
          group?: string;
          limit?: number;
          offset?: number;
          order?: string;
          quote?: string;
          references?: string;
          search_after?: string;
          sort?: string;
          tag?: string;
          tags?: string[];
          text?: string;
          uri?: string;
          url?: string;
          url.parts?: string;
          user?: string;
          wildcard_uri?: string;
      }

      Search query object

      • Optional _separate_replies?: boolean
      • Optional any?: string
      • Optional group?: string
      • Optional limit?: number
      • Optional offset?: number
      • Optional order?: string
      • Optional quote?: string
      • Optional references?: string
      • Optional search_after?: string
      • Optional sort?: string
      • Optional tag?: string
      • Optional tags?: string[]
      • Optional text?: string
      • Optional uri?: string
      • Optional url?: string
      • Optional url.parts?: string
      • Optional user?: string
      • Optional wildcard_uri?: string

    Returns Promise<Result>

Generated using TypeDoc