Skip to content

Commit

Permalink
docs: adding documentation to the code
Browse files Browse the repository at this point in the history
  • Loading branch information
Rafał Pawłaszek committed Sep 13, 2023
1 parent 6b50a31 commit 4f76a9c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions src/core/flows/flow-base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,45 @@ import { IDestination } from '../vertices/destination';
import { ISource } from '../vertices/source';

export interface IFlow extends IResource {
/**
* The ARN of the flow.
*/
readonly arn: string;

/**
* The name of the flow
*/
readonly name: string;

/**
* The type of the flow.
*/
readonly type: FlowType;

onRunStarted(id: string, options?: OnEventOptions): Rule;

onRunCompleted(id: string, options?: OnEventOptions): Rule;

/**
* @internal
*/
_addMapping(mapping: IMapping): IFlow;

/**
* @internal
*/
_addValidation(validator: IValidation): IFlow;

/**
* @internal
*/
_addTransform(transform: ITransform): IFlow;

/**
* @internal
*/
_addFilter(filter: IFilter): IFlow;

/**
* @internal
*/
Expand Down Expand Up @@ -113,9 +129,19 @@ export interface FlowBaseProps extends FlowProps {

export abstract class FlowBase extends Resource implements IFlow {

/**
* The ARN of the flow.
*/
public readonly arn: string;

/**
* The type of the flow.
*/
public readonly type: FlowType;

/**
* The name of the flow.
*/
public readonly name: string;

private readonly mappings: CfnFlow.TaskProperty[] = [];
Expand Down

0 comments on commit 4f76a9c

Please sign in to comment.