Skip to content

Latest commit

 

History

History
155 lines (93 loc) · 4.8 KB

API.md

File metadata and controls

155 lines (93 loc) · 4.8 KB
Raw

API Reference

Constructs

SampleRepository

SampleRepository is a repository that only allows configuring its.

Initializers 

import { SampleRepository } from 'construct-hub-probe'

new SampleRepository(scope: Construct, id: string, props: SampleRepositoryProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props SampleRepositoryProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { SampleRepository } from 'construct-hub-probe'

SampleRepository.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Structs

SampleRepositoryProps

Properties for 'SampleRepositoryProps'.

Initializer 

import { SampleRepositoryProps } from 'construct-hub-probe'

const sampleRepositoryProps: SampleRepositoryProps = { ... }

Properties

Name Type Description
name string Repository name.
nameRequired 
public readonly name: string;
  • Type: string

Repository name.