Class OrbRef<Literal>

An abstract reference to an orb component. {@label STATIC_2.1}

Type Parameters

Literal extends AnyParameterLiteral

Hierarchy

OrbRef

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new OrbRef<Literal>(name: string, parameters: CustomParametersList<Literal>, orb: OrbImport): OrbRef<Literal>

- Defined in src/lib/Orb/exports/OrbRef.ts:15
Type Parameters
- Literal extends AnyParameterLiteral
Parameters
- name: string
- parameters: CustomParametersList<Literal>
- orb: OrbImport
Returns OrbRef<Literal>

Properties

Private _name

_name: string

Private _orb

_orb: OrbImport

Private _parameters

_parameters: CustomParametersList<Literal>

Accessors

generableType

get generableType(): GenerableType

- Defined in src/lib/Orb/exports/OrbRef.ts:25
Returns GenerableType

name

get name(): string

- Defined in src/lib/Orb/exports/OrbRef.ts:29
Returns string

orb

get orb(): OrbImport

- Defined in src/lib/Orb/exports/OrbRef.ts:37
Returns OrbImport

parameters

get parameters(): CustomParametersList<Literal>

- Defined in src/lib/Orb/exports/OrbRef.ts:33
Returns CustomParametersList<Literal>

Generated using TypeDoc