Class.Resource

@decentm/concourse-ts / Resource

Class: Resource<Source, PutParams, GetParams>

Type parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

Constructors

new Resource()

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

Parameters

• name: string

• type: ResourceType<string, Config>

• customise?

Returns

Resource<Source, PutParams, GetParams>

Source

components/resource.ts:90

Properties

icon?

optional icon: string

https://materialdesignicons.com/

Source

components/resource.ts:135

---

name

name: string

Source

components/resource.ts:88

---

old_name?

optional old_name: string

Source

components/resource.ts:137

---

public?

optional public: boolean

Source

components/resource.ts:139

---

source?

optional source: Source

Source

components/resource.ts:124

---

webhook_token?

optional webhook_token: string

Source

components/resource.ts:155

Methods

add_tag()

add_tag(...tags): void

Parameters

• ...tags: string[]

Returns

void

Source

components/resource.ts:143

---

as_get_step()

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

Parameters

• input?: AsGetStepInput<GetParams>

• customise?

Returns

GetStep<Source, PutParams, GetParams>

Source

components/resource.ts:186

---

as_put_step()

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

Parameters

• input?: AsPutStepInput<PutParams>

• customise?

Returns

PutStep<Source, PutParams, GetParams>

Source

components/resource.ts:157

---

customise_get_step()

customise_get_step(init): void

Parameters

• init

Returns

void

Source

components/resource.ts:68

---

customise_put_step()

customise_put_step(init): void

Parameters

• init

Returns

void

Source

components/resource.ts:79

---

serialise()

serialise(): Resource

Returns

Resource

Source

components/resource.ts:219

---

set_check_every()

set_check_every(input): void

Parameters

• input: DurationInput | "never"

Returns

void

Source

components/resource.ts:128

---

set_version()

set_version(version): void

Parameters

• version: Version

Returns

void

Source

components/resource.ts:151

---

customise()

static customise(init): void

Parameters

• init

Returns

void

Source

components/resource.ts:32

---

customise_get_step()

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

Type parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

Parameters

• init

Returns

void

Source

components/resource.ts:38

---

customise_put_step()

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

Type parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

Parameters

• init

Returns

void

Source

components/resource.ts:53