Class.Resource

@decentm/concourse-ts / Resource

Class: Resource<Source, PutParams, GetParams, ResourceTypeType, ResourceTypeConfig>

Defined in: components/resource.ts:25

Type Parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

• ResourceTypeType extends string = string

• ResourceTypeConfig extends Config = Config

Constructors

new Resource()

new Resource<Source, PutParams, GetParams, ResourceTypeType, ResourceTypeConfig>(name, type, customise?): Resource<Source, PutParams, GetParams, ResourceTypeType, ResourceTypeConfig>

Defined in: components/resource.ts:92

Parameters

name

string

type

ResourceType<ResourceTypeType, ResourceTypeConfig>

customise?

(instance) => void

Returns

Resource<Source, PutParams, GetParams, ResourceTypeType, ResourceTypeConfig>

Properties

icon?

optional icon: string

Defined in: components/resource.ts:137

https://materialdesignicons.com/

---

name

name: string

Defined in: components/resource.ts:90

---

old_name?

optional old_name: string

Defined in: components/resource.ts:139

---

public?

optional public: boolean

Defined in: components/resource.ts:141

---

source?

optional source: Source

Defined in: components/resource.ts:126

---

webhook_token?

optional webhook_token: string

Defined in: components/resource.ts:157

Methods

add_tag()

add_tag(...tags): void

Defined in: components/resource.ts:145

Parameters

tags

...string[]

Returns

void

---

as_get_step()

as_get_step(input?, customise?): GetStep<Source, PutParams, GetParams>

Defined in: components/resource.ts:188

Parameters

input?

AsGetStepInput<GetParams>

customise?

(instance) => void

Returns

GetStep<Source, PutParams, GetParams>

---

as_put_step()

as_put_step(input?, customise?): PutStep<Source, PutParams, GetParams>

Defined in: components/resource.ts:159

Parameters

input?

AsPutStepInput<PutParams>

customise?

(instance) => void

Returns

PutStep<Source, PutParams, GetParams>

---

customise_get_step()

customise_get_step(init): void

Defined in: components/resource.ts:70

Parameters

init

(instance, parent) => void

Returns

void

---

customise_put_step()

customise_put_step(init): void

Defined in: components/resource.ts:81

Parameters

init

(instance, parent) => void

Returns

void

---

serialise()

serialise(): Resource

Defined in: components/resource.ts:221

Returns

Resource

---

set_check_every()

set_check_every(input): void

Defined in: components/resource.ts:130

Parameters

input

DurationInput | "never"

Returns

void

---

set_version()

set_version(version): void

Defined in: components/resource.ts:153

Parameters

version

Version

Returns

void

---

customise()

static customise(init): void

Defined in: components/resource.ts:34

Parameters

init

(instance) => void

Returns

void

---

customise_get_step()

static customise_get_step<Source, PutParams, GetParams>(init): void

Defined in: components/resource.ts:40

Type Parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

Parameters

init

(instance, parent) => void

Returns

void

---

customise_put_step()

static customise_put_step<Source, PutParams, GetParams>(init): void

Defined in: components/resource.ts:55

Type Parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

Parameters

init

(instance, parent) => void

Returns

void