Skip to main content
Version: Next

Interface: Config

Configuration object with additional methods for configuration, includes yaml and internal medatada.

Interface

Config

Hierarchy

Indexable

[key: string]: any

Properties

_debug

Optional _debug: boolean

Inherited from

Omit._debug

Defined in

packages/core/types/src/configuration.ts:252


auth

Optional auth: any

Inherited from

Omit.auth

Defined in

packages/core/types/src/configuration.ts:260


configPath

configPath: string

Defined in

packages/core/types/src/configuration.ts:297


experiments

Optional experiments: FlagsConfig

Inherited from

Omit.experiments

Defined in

packages/core/types/src/configuration.ts:280


filters

Optional filters: any

Inherited from

Omit.filters

Defined in

packages/core/types/src/configuration.ts:275


flags

Optional flags: FlagsConfig

Inherited from

Omit.flags

Defined in

packages/core/types/src/configuration.ts:278


http_proxy

Optional http_proxy: string

Inherited from

Omit.http_proxy

Defined in

packages/core/types/src/configuration.ts:267


https

Optional https: HttpsConf

Inherited from

Omit.https

Defined in

packages/core/types/src/configuration.ts:265


https_proxy

Optional https_proxy: string

Inherited from

Omit.https_proxy

Defined in

packages/core/types/src/configuration.ts:269


i18n

Optional i18n: Object

Type declaration

NameType
webstring

Inherited from

Omit.i18n

Defined in

packages/core/types/src/configuration.ts:285


listen

Optional listen: ListenAddress

Inherited from

Omit.listen

Defined in

packages/core/types/src/configuration.ts:264


log

Optional log: LoggerConfItem

Inherited from

Omit.log

Defined in

packages/core/types/src/configuration.ts:256


logs

Optional logs: LoggerConfItem

Inherited from

Omit.logs

Defined in

packages/core/types/src/configuration.ts:258


max_body_size

Optional max_body_size: string

Inherited from

Omit.max_body_size

Defined in

packages/core/types/src/configuration.ts:271


middlewares

Optional middlewares: any

Inherited from

Omit.middlewares

Defined in

packages/core/types/src/configuration.ts:274


no_proxy

Optional no_proxy: string

Inherited from

Omit.no_proxy

Defined in

packages/core/types/src/configuration.ts:270


notifications

Optional notifications: Notifications

Inherited from

Omit.notifications

Defined in

packages/core/types/src/configuration.ts:272


notify

Optional notify: Notifications | Notifications[]

Inherited from

Omit.notify

Defined in

packages/core/types/src/configuration.ts:273


packages

packages: PackageList

Defined in

packages/core/types/src/configuration.ts:301


plugins

Optional plugins: null | string | void

Inherited from

Omit.plugins

Defined in

packages/core/types/src/configuration.ts:268


publish

Optional publish: PublishOptions

Inherited from

Omit.publish

Defined in

packages/core/types/src/configuration.ts:262


secret

secret: string

Defined in

packages/core/types/src/configuration.ts:295


security

security: Security

Defined in

packages/core/types/src/configuration.ts:303


self_path

Optional self_path: string

Defined in

packages/core/types/src/configuration.ts:299


server

Optional server: ServerSettingsConf

Inherited from

Omit.server

Defined in

packages/core/types/src/configuration.ts:277


server_id

server_id: string

Defined in

packages/core/types/src/configuration.ts:294


storage

Optional storage: string | void

Inherited from

Omit.storage

Defined in

packages/core/types/src/configuration.ts:253


store

Optional store: any

Inherited from

Omit.store

Defined in

packages/core/types/src/configuration.ts:263


uplinks: UpLinksConfList

Inherited from

Omit.uplinks

Defined in

packages/core/types/src/configuration.ts:255


url_prefix

Optional url_prefix: string

Inherited from

Omit.url_prefix

Defined in

packages/core/types/src/configuration.ts:276


userRateLimit

Optional userRateLimit: RateLimit

Inherited from

Omit.userRateLimit

Defined in

packages/core/types/src/configuration.ts:281


user_agent

Optional user_agent: string

Inherited from

Omit.user_agent

Defined in

packages/core/types/src/configuration.ts:266


web

Optional web: WebConf

Inherited from

Omit.web

Defined in

packages/core/types/src/configuration.ts:259

Methods

checkSecretKey

checkSecretKey(token): string

Parameters

NameType
tokenstring | void

Returns

string

Defined in

packages/core/types/src/configuration.ts:305


getMatchedPackagesSpec

getMatchedPackagesSpec(storage): void | PackageAccess

Parameters

NameType
storagestring

Returns

void | PackageAccess

Defined in

packages/core/types/src/configuration.ts:306