Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/.nojekyll

This file was deleted.

14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
@time-loop/cdk-s3-file-generator
**@time-loop/cdk-s3-file-generator** • **Docs**

# @time-loop/cdk-s3-file-generator
***

## Table of contents
# @time-loop/cdk-s3-file-generator

### Enumerations
## Enumerations

- [GeneratorFileType](enums/GeneratorFileType.md)
- [GeneratorFileType](enumerations/GeneratorFileType.md)

### Classes
## Classes

- [Generator](classes/Generator.md)

### Interfaces
## Interfaces

- [GeneratorProps](interfaces/GeneratorProps.md)
- [SerializerProps](interfaces/SerializerProps.md)
Expand Down
105 changes: 40 additions & 65 deletions docs/classes/Generator.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,54 @@
[**@time-loop/cdk-s3-file-generator**](../README.md) • **Docs**

***

[@time-loop/cdk-s3-file-generator](../README.md) / Generator

# Class: Generator

## Hierarchy
## Extends

- `BucketDeployment`

↳ **`Generator`**

## Table of contents

### Constructors

- [constructor](Generator.md#constructor)

### Properties

- [node](Generator.md#node)

### Accessors
## Constructors

- [deployedBucket](Generator.md#deployedbucket)
- [objectKeys](Generator.md#objectkeys)
### new Generator()

### Methods
> **new Generator**(`scope`, `id`, `props`): [`Generator`](Generator.md)

- [addSource](Generator.md#addsource)
- [toString](Generator.md#tostring)
- [isConstruct](Generator.md#isconstruct)
#### Parameters

## Constructors
• **scope**: `Construct`

### constructor
• **id**: `string`

• **new Generator**(`scope`, `id`, `props`)
• **props**: [`GeneratorProps`](../interfaces/GeneratorProps.md)

#### Parameters
#### Returns

| Name | Type |
| :------ | :------ |
| `scope` | `Construct` |
| `id` | `string` |
| `props` | [`GeneratorProps`](../interfaces/GeneratorProps.md) |
[`Generator`](Generator.md)

#### Overrides

BucketDeployment.constructor
`BucketDeployment.constructor`

## Properties

### node

• `Readonly` **node**: `Node`
> `readonly` **node**: `Node`

The tree node.

#### Inherited from

BucketDeployment.node
`BucketDeployment.node`

## Accessors

### deployedBucket

`get` **deployedBucket**(): `IBucket`
> `get` **deployedBucket**(): `IBucket`

The bucket after the deployment

Expand All @@ -79,15 +64,11 @@ on the bucket deployment instead: `otherResource.node.addDependency(deployment)`

`IBucket`

#### Inherited from

BucketDeployment.deployedBucket

___
***

### objectKeys

`get` **objectKeys**(): `string`[]
> `get` **objectKeys**(): `string`[]

The object keys for the sources deployed to the S3 bucket.

Expand All @@ -104,29 +85,27 @@ first source file in your bucket deployment.

`string`[]

#### Inherited from

BucketDeployment.objectKeys

## Methods

### addSource
### addSource()

**addSource**(`source`): `void`
> **addSource**(`source`): `void`

Add an additional source to the bucket deployment

#### Parameters

| Name | Type |
| :------ | :------ |
| `source` | `ISource` |
• **source**: `ISource`

#### Returns

`void`

**`Example`**
#### Inherited from

`BucketDeployment.addSource`

#### Example

```ts
declare const websiteBucket: s3.IBucket;
Expand All @@ -138,15 +117,11 @@ const deployment = new s3deploy.BucketDeployment(this, 'Deployment', {
deployment.addSource(s3deploy.Source.asset('./another-asset'));
```

#### Inherited from

BucketDeployment.addSource

___
***

### toString
### toString()

**toString**(): `string`
> **toString**(): `string`

Returns a string representation of this construct.

Expand All @@ -156,13 +131,13 @@ Returns a string representation of this construct.

#### Inherited from

BucketDeployment.toString
`BucketDeployment.toString`

___
***

### isConstruct
### isConstruct()

▸ `Static` **isConstruct**(`x`): x is Construct
> `static` **isConstruct**(`x`): `x is Construct`

Checks if `x` is a construct.

Expand All @@ -182,16 +157,16 @@ this type-testing method instead.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `x` | `any` | Any object |
• **x**: `any`

Any object

#### Returns

x is Construct
`x is Construct`

true if `x` is an object created from a class which extends `Construct`.

#### Inherited from

BucketDeployment.isConstruct
`BucketDeployment.isConstruct`
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
[@time-loop/cdk-s3-file-generator](../README.md) / GeneratorFileType

# Enumeration: GeneratorFileType
[**@time-loop/cdk-s3-file-generator**](../README.md) • **Docs**

## Table of contents
***

### Enumeration Members
[@time-loop/cdk-s3-file-generator](../README.md) / GeneratorFileType

- [JSON](GeneratorFileType.md#json)
# Enumeration: GeneratorFileType

## Enumeration Members

### JSON

**JSON** = ``"generator_json"``
> **JSON**: `"generator_json"`
Loading