Skip to content

Commit

Permalink
Add docstrings as requested
Browse files Browse the repository at this point in the history
  • Loading branch information
t0yv0 committed Nov 19, 2024
1 parent 841fb62 commit 90981be
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/converters/intrinsics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,18 @@ import * as equal from 'fast-deep-equal';
* @internal
*/
export interface Intrinsic {
/**
* The name of the intrinsic function such as 'Fn::If'.
*/
name: string;

/**
* Executes the logic to evaluate CF expressions and compute the result.
*
* Most intrinsics need to use IntrinsicContext.evaluate right away to find the values of parameters before
* processing them. Conditional intrinsics such as 'Fn::If' or 'Fn::Or' are an exception to this and need to
* evaluate their parameters only when necessary.
*/
evaluate(ctx: IntrinsicContext, params: Expression[]): Result<any>;
}

Expand Down

0 comments on commit 90981be

Please sign in to comment.