TSDoc

A page to test all the TSDoc cases.

Returns a locale object for the specified definition with locale.format and locale.formatPrefix methods.

This section has more from about the FormatSpecifier.

Simple Example

Here’s a simple example.

new FormatSpecifier("param1");

Complicated Example

Here’s a more complicated example.

new FormatSpecifier("param1", "param2", "param3");

For more info refer to our other docs.

Constructor

new FormatSpecifier(specifier, addend?): FormatSpecifier

Parameters

specifier FormatSpecifierObject

A specifier object.
addend? number | string & boolean

A number to add.

Returns FormatSpecifier[] | null

Methods

noop

noop(): void

This function doesn’t do anything.

simpleArgs

simpleArgs(true, false ,true): void

This function takes some simple args.

Parameters

isTrue boolean
isFalse? boolean
isAny? boolean

fullArgs

fullArgs(true, false ,true): FormatSpecifier

This function takes full args.

Type Object

prop1? boolean

Default true

A simple prop to add.
prop2? “x86_64” | “arm_64”

Default Uses x86 by default x86_64. But this description of the default is really long and runs more than one single line.

A complex prop to add with a description that is longer than one line. This matters because

A simple example.
```
{ prop2: "x86_64" }
```
A more complicated multi-line example.
```
{
  prop2: "x86_64"
}
```
prop3? FormatSpecifier[] | null

Default true

Just pass something in.
```
{
  prop2: "x86_64"
}
```

Returns FormatSpecifier[] | null

Here’s an example.

function demo() {
  return fullArgs(true, false ,true);
}

And another example.

const a = 1;
const b = a + 1;

fullArgs(true, false ,true);

Properties

primitiveProp

The ARN of the resource.

Type “x86_64” | “arm_64”

objectProp

A simple object prop.

Type Object

resource1 string
resource2 FormatSpecifier

objectPropNested

A nested object prop.

Type Object

resource1 Output<Object>
- objectKey1 Object
  - objectKey11 Object[]
    - key111 boolean
    - objectKey112 Object
      - key1111 string
      - key1112 string
- key2 boolean
resource2 FormatSpecifier

objectPropNested.objectKey1

A simple object prop.

Type Output<Object>

objectPropNested.resource1.objectKey1

A simple object prop.

Type Object

objectPropNested.resource1.objectKey1.objectKey11

A simple object prop.

Type Object[]

objectPropNested.resource1.objectKey1.objectKey11[].objectKey112

A simple object prop.

Type Object

objectPropNested.resource1.objectKey1.objectKey11[].objectKey112.key1111

A simple prop.

Type string

DummyArgs

simpleArg

The CPU architecture of the lambda function.

Type “x86_64” | “arm_64”

Default Uses x86 by default x86_64. But this description of the default is really long and runs more than one single line.

For example,

new Function(stack, "Function", {
  architecture: "arm_64",
})

objectPropSimple?

A prop that takes an object with simple keys.

Type Object

isTrue boolean
isFalse? boolean
isAny? boolean

Default undefined

new Function(stack, "Function", {
  architecture: "arm_64",
})

objectPropFull?

A prop that takes an object with full keys.

Type Object

prop1? boolean

Default true

A simple prop to add.
```
{
  prop1: true
}
```
prop2? “x86_64” | “arm_64”

Default Uses x86 by default x86_64. But this description of the default is really long and runs more than one single line.

A complex prop to add with a description that is longer than one line. This matters because

A simple example.
```
{ prop2: "x86_64" }
```
A more complicated multi-line example.
```
{
  prop2: "x86_64"
}
```
prop3? FormatSpecifier[] | null

Default true

Just pass something in.
```
{
  prop2: "x86_64"
}
```

Default undefined

new Function(stack, "Function", {
  architecture: "arm_64",
})

transform?

Transform how this component is created.

Type Object

resource1? FormatSpecifier | (args: FormatSpecifier => FormatSpecifier | void)
resource1? FormatSpecifier | (args: FormatSpecifier => FormatSpecifier | void)

Default undefined