Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IEnvironment

Implemented by

Index

Methods

  • exists(path: string): boolean
  • Проверяет наличие настройки

    Parameters

    • path: string

      путь к настройке. Аналогичен path в get

    Returns boolean

  • get<T>(path?: string, defaultValue?: T): T
  • Возвращает настройки приложения

    example
    client.environment.get()
    

    без значения метод вернёт объект текущих настроек

    example
    client.environment.get('domain')
    

    вернёт имя домена портала

    example
    client.environment.get('auth')
    

    вернёт объект настроек авторизации

    example
    client.environment.get('auth.client_id')
    

    вернёт id OAuth-приложения AmoCRM

    Type parameters

    • T

    Parameters

    • Optional path: string

      путь к настройке(ам)

    • Optional defaultValue: T

      значение, которое вернётся при отсутствии настройки

    Returns T

    значение настройки. При отсутствии значения вернётся defaultValue

  • Устанавливает новое значение настройки

    Parameters

    • path: string

      путь к настройке. Аналогичен path в get

    • value: JSONValue

      новое значение

    Returns void

Generated using TypeDoc