Class If

Simple two-way conditional expression.

Hierarchy

Expr
- If

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new If(cond: Expr, thenBranch: Expr, elseBranch?: Expr): If

Overrides Expr.constructor
- Defined in src/ast/If.ts:10
Create a new If expression.

When this If expression is executed, the condition will be evaluated, and if it produces a true value, thenBranch will be executed and used as the return value for this expression. Otherwise, elseBranch will be executed and used as the return value, if it is provided.

Parameters
- cond: Expr
  
  The condition to check. Must evaluate to uint64.
- thenBranch: Expr
  
  Expression to evaluate if the condition is true.
- Optional elseBranch: Expr
  
  Expression to evaluate if the condition is false. Must evaluate to the same type as thenBranch, if provided. Defaults to None.
Returns If

Properties

cond

cond: Expr

Optional elseBranch

elseBranch: Expr

thenBranch

thenBranch: Expr

Methods

And

And(other: Expr): Expr

Inherited from Expr.And
- Defined in src/ast/Expr.ts:105
Take the logical And of this expression and another one.

This expression must evaluate to uint64.

This is the same as using And() with two arguments.

Parameters
- other: Expr
Returns Expr

Or

Or(other: Expr): Expr

Inherited from Expr.Or
- Defined in src/ast/Expr.ts:119
Take the logical Or of this expression and another one.

This expression must evaluate to uint64.

This is the same as using Or() with two arguments.

Parameters
- other: Expr
Returns Expr

add

add(other: Expr): BinaryExpr

Inherited from Expr.add
- Defined in src/ast/Expr.ts:58
Parameters
- other: Expr
Returns BinaryExpr

and

and(other: Expr): BinaryExpr

Inherited from Expr.and
- Defined in src/ast/Expr.ts:82
Parameters
- other: Expr
Returns BinaryExpr

eq

eq(other: Expr): BinaryExpr

Inherited from Expr.eq
- Defined in src/ast/Expr.ts:50
Parameters
- other: Expr
Returns BinaryExpr

ge

ge(other: Expr): BinaryExpr

Inherited from Expr.ge
- Defined in src/ast/Expr.ts:46
Parameters
- other: Expr
Returns BinaryExpr

gt

gt(other: Expr): BinaryExpr

Inherited from Expr.gt
- Defined in src/ast/Expr.ts:38
Parameters
- other: Expr
Returns BinaryExpr

invert

invert(): UnaryExpr

Inherited from Expr.invert
- Defined in src/ast/Expr.ts:78
Returns UnaryExpr

le

le(other: Expr): BinaryExpr

Inherited from Expr.le
- Defined in src/ast/Expr.ts:42
Parameters
- other: Expr
Returns BinaryExpr

lt

lt(other: Expr): BinaryExpr

Inherited from Expr.lt
- Defined in src/ast/Expr.ts:34
Parameters
- other: Expr
Returns BinaryExpr

mod

mod(other: Expr): BinaryExpr

Inherited from Expr.mod
- Defined in src/ast/Expr.ts:74
Parameters
- other: Expr
Returns BinaryExpr

mul

mul(other: Expr): BinaryExpr

Inherited from Expr.mul
- Defined in src/ast/Expr.ts:66
Parameters
- other: Expr
Returns BinaryExpr

ne

ne(other: Expr): BinaryExpr

Inherited from Expr.ne
- Defined in src/ast/Expr.ts:54
Parameters
- other: Expr
Returns BinaryExpr

or

or(other: Expr): BinaryExpr

Inherited from Expr.or
- Defined in src/ast/Expr.ts:86
Parameters
- other: Expr
Returns BinaryExpr

sub

sub(other: Expr): BinaryExpr

Inherited from Expr.sub
- Defined in src/ast/Expr.ts:62
Parameters
- other: Expr
Returns BinaryExpr

teal

teal(options: CompileOptions): CompiledExpr

Overrides Expr.teal
- Defined in src/ast/If.ts:38
Parameters
- options: CompileOptions
Returns CompiledExpr

toString

toString(): string

- Defined in src/ast/If.ts:66
Returns string

truediv

truediv(other: Expr): BinaryExpr

Inherited from Expr.truediv
- Defined in src/ast/Expr.ts:70
Parameters
- other: Expr
Returns BinaryExpr

typeOf

typeOf(): TealType

Overrides Expr.typeOf
- Defined in src/ast/If.ts:62
Returns TealType

xor

xor(other: Expr): BinaryExpr

Inherited from Expr.xor
- Defined in src/ast/Expr.ts:90
Parameters
- other: Expr
Returns BinaryExpr

Generated using TypeDoc