Node SDK

Class ObjectConfiguration

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Class
  • Constructor
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Inherited property
  • Inherited method
  • Enumeration

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

LeoCron

LeoCron: string

LeoEvent

LeoEvent: string

LeoFirehoseStream

LeoFirehoseStream: string

LeoKinesisStream

LeoKinesisStream: string

LeoS3

LeoS3: string

LeoSettings

LeoSettings: string

LeoStream

LeoStream: string

Optional LeoSystem

LeoSystem?: string

Region

Region: string

expireTime

expireTime: number = 0

expired

expired: boolean = false

expiryWindow

expiryWindow: number = 15
returns

the number of seconds before {expireTime} during which the configuration will be considered expired.

field

field: string

root

root: any

Methods

getSync

  • getSync(): void

  • Gets the existing configuration, refreshing them if they are not yet loaded or have expired. Users should call this method before using {refresh}, as this will not attempt to reload configuration when they are already loaded into the object.

    Returns void

needsRefresh

  • needsRefresh(): boolean

refreshSync

resolveSync

  • resolveSync(): { LeoCron: string; LeoEvent: string; LeoFirehoseStream: string; LeoKinesisStream: string; LeoS3: string; LeoSettings: string; LeoStream: string; LeoSystem: string; Region: string }

  • Returns { LeoCron: string; LeoEvent: string; LeoFirehoseStream: string; LeoKinesisStream: string; LeoS3: string; LeoSettings: string; LeoStream: string; LeoSystem: string; Region: string }

    • LeoCron: string
    • LeoEvent: string
    • LeoFirehoseStream: string
    • LeoKinesisStream: string
    • LeoS3: string
    • LeoSettings: string
    • LeoStream: string
    • LeoSystem: string
    • Region: string

update

  • update(config?: any): void

Generated using TypeDoc