Class Return

Hierarchy

Expression<any>
- Return

Index

Constructors

constructor

Properties

expr
postWS

Accessors

ws

Methods

Constructors

constructor

new Return(expr: Expression<any>, preWS?: string, postWS?: string): Return

Overrides Expression.constructor
- Defined in lib/structural/Return.ts:4
Constructor for a Return object, representing something to be returned in a function

Parameters
- expr: Expression<any>
  
  The expression to be returned
- Default value preWS: string = ""
  
  Whitespace preceding the keyword 'return'
- Default value postWS: string = ""
  
  Whitespace succeeding the keyword 'return'
Returns Return

Properties

Private expr

expr: Expression<any>

The expression to be returned

Private postWS

postWS: string

Whitespace succeeding the keyword 'return'

Accessors

ws

get ws(): string
set ws(ws: string): void

Inherited from Expression.ws
- Defined in lib/Expression.ts:39
Returns the whitespace preceding the expression

Returns string
Inherited from Expression.ws
- Defined in lib/Expression.ts:46
Sets the whitespace preceding the expression

Parameters
- ws: string
Returns void

Methods

equals

equals(right: Expression<any>): boolean

Inherited from Expression.equals
- Defined in lib/Expression.ts:30
Returns whether the Expression equals another Expression

Parameters
- right: Expression<any>
  
  The right side of the equality
Returns boolean

eval

eval(scope: Scope): any

Overrides Expression.eval
- Defined in lib/structural/Return.ts:20
Evaluates the expression to be returned and returns via a ReturnErro

Parameters
- scope: Scope
Returns any

toString

toString(): string

Overrides Expression.toString
- Defined in lib/structural/Return.ts:24
Returns string

Generated using TypeDoc