API.md

API Reference

Structs

FunctionParams

Function parameters.

Initializer

import { FunctionParams } from 'jsii-docgen-mre'

const functionParams: FunctionParams = { ... }

Properties

Name	Type	Description
paramOne	string | IOne[]	No description.
paramTwo	IOne[] | string[]	No description.

---

paramOne^Required

public readonly paramOne: string | IOne[];

• Type: string | IOne[]

---

paramTwo^Required

public readonly paramTwo: IOne[] | string[];

• Type: IOne[] | string[]

---

Classes

ConstructFoo

Initializers

import { ConstructFoo } from 'jsii-docgen-mre'

new ConstructFoo(fnParams: FunctionParams)

Name	Type	Description
fnParams	FunctionParams	No description.

---

fnParams^Required

• Type: FunctionParams

---

Methods

Name	Description
add	No description.

---

add

public add(num_one: number, num_two: number): number

num_one^Required

• Type: number

---

num_two^Required

• Type: number

---

Properties

Name	Type	Description
internalParam	string | IOne[]	No description.

---

internalParam^Required

public readonly internalParam: string | IOne[];

• Type: string | IOne[]

---

Protocols

IOne

• Implemented By: IOne

Interface for providing config for paramOne.

Properties

Name	Type	Description
foo	string	Param foo.

---

foo^Required

public readonly foo: string;

• Type: string

Param foo.

---