Jira.js - Jira Cloud API library
    Preparing search index...

    Class BaseClient

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    • Parameters

      • config: {
            authentication?:
                | { basic: { apiToken: string; email: string } }
                | { oauth2: { accessToken: string } };
            baseRequestConfig?: any;
            host: string;
            middlewares?: {
                onError?: (...args: [any, ...unknown[]]) => void;
                onResponse?: (...args: [any, ...unknown[]]) => void;
            };
            noCheckAtlassianToken?: boolean;
            strictGDPR?: boolean;
        }
        • Optionalauthentication?:
              | { basic: { apiToken: string; email: string } }
              | { oauth2: { accessToken: string } }
        • OptionalbaseRequestConfig?: any
        • host: string
        • Optionalmiddlewares?: {
              onError?: (...args: [any, ...unknown[]]) => void;
              onResponse?: (...args: [any, ...unknown[]]) => void;
          }
        • OptionalnoCheckAtlassianToken?: boolean

          Adds 'X-Atlassian-Token': 'no-check' to each request header

        • OptionalstrictGDPR?: boolean

      Returns BaseClient

    Properties

    config: {
        authentication?:
            | { basic: { apiToken: string; email: string } }
            | { oauth2: { accessToken: string } };
        baseRequestConfig?: any;
        host: string;
        middlewares?: {
            onError?: (...args: [any, ...unknown[]]) => void;
            onResponse?: (...args: [any, ...unknown[]]) => void;
        };
        noCheckAtlassianToken?: boolean;
        strictGDPR?: boolean;
    }

    Type declaration

    • Optionalauthentication?:
          | { basic: { apiToken: string; email: string } }
          | { oauth2: { accessToken: string } }
    • OptionalbaseRequestConfig?: any
    • host: string
    • Optionalmiddlewares?: {
          onError?: (...args: [any, ...unknown[]]) => void;
          onResponse?: (...args: [any, ...unknown[]]) => void;
      }
    • OptionalnoCheckAtlassianToken?: boolean

      Adds 'X-Atlassian-Token': 'no-check' to each request header

    • OptionalstrictGDPR?: boolean

    Methods

    • Parameters

      • parameters: Record<string, any>

      Returns string

    • Parameters

      • obj: Record<string, any>

      Returns Record<string, any>