API.md

API Reference

Table of Contents

• Classes
  • Results
  • Check
  • CheckHttp
• Interfaces
  • ICheck
• Structs
  • CheckResult
  • CheckProps
  • CheckHttpProps

Results (preflight class)

No description

Constructor

new(): Results

Properties

No properties

Methods

Signature	Description
inflight latest(checkid: str): CheckResult?	No description
static of(scope: IResource): Results	No description
inflight store(result: CheckResult): void	No description

Check (preflight class)

No description

Constructor

new(handler: inflight (): void, props: CheckProps?): Check

Properties

No properties

Methods

Signature	Description
inflight latest(): CheckResult?	No description
inflight run(): CheckResult	No description

CheckHttp (preflight class)

No description

Constructor

new(url: str, options: CheckHttpProps?): CheckHttp

Properties

No properties

Methods

Signature	Description
inflight latest(): CheckResult?	No description
inflight run(): CheckResult	No description

ICheck (interface)

No description

Properties

No properties

Methods

Signature	Description
inflight latest(): CheckResult?	No description
inflight run(): CheckResult	No description

CheckResult (struct)

No description

Properties

Name	Type	Description
checkid	str	No description
checkpath	str	No description
error	str?	No description
ok	bool	No description
timestamp	str	No description

CheckProps (struct)

No description

Properties

Name	Type	Description
deploy	bool?	No description
rate	duration?	No description
testing	bool?	No description

CheckHttpProps (struct)

No description

Properties

Name	Type	Description
body	str?	No description
deploy	bool?	No description
method	HttpMethod?	No description
path	str?	No description
rate	duration?	No description
status	num?	No description
testing	bool?	No description