Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "index"

Index

Type aliases

Args

Args: object
typedef

{Object} Args

prop

{string} domain

prop

{token} token

prop

{string} [baseURL]

prop

{timeout} [timeout]

prop

{version} [version]

Type declaration

  • Optional baseURL?: undefined | string
  • domain: string
  • Optional timeout?: undefined | number
  • token: string
  • Optional version?: undefined | number

Resources

Resources: object
typedef

{Object} Resources

prop

{Comment} comment

prop

{Group} group

prop

{Post} post

prop

{Tag} tag

prop

{Team} team

prop

{User} user

Type declaration

Variables

Const DEFAULT_BASE_URL

DEFAULT_BASE_URL: string = "https://api.docbase.io"
const

{string}

Const DEFAULT_TIMEOUT

DEFAULT_TIMEOUT: number = 3000
const

{number}

Const DEFAULT_VERSION

DEFAULT_VERSION: number = 2
const

{number}

Functions

docbase

  • docbase(__namedParameters: object): Resources
  • Create API clients

    Parameters

    • __namedParameters: object
      • baseURL: undefined | string
      • domain: string
      • timeout: undefined | number
      • token: string
      • version: undefined | number

    Returns Resources

Generated using TypeDoc