Tagscript

tagscript


Class: Response

Defined in: Interpreter/Response.ts:6

An object containing information on a completed TagScript process.

Constructors

new Response()

new Response(variables, keyValues): Response

Defined in: Interpreter/Response.ts:40

Parameters

variables
keyValues

IKeyValues = {}

Returns

Response

Properties

actions

actions: IActions

Defined in: Interpreter/Response.ts:36

An object containing information on a completed TagScript process. If you are creating a parser where you need to store info in actions, then you need to extend this interface.

import 'tagscript';
declare module 'tagscript' {
	interface IActions {
foo?: string;
	}
}

body

body: null | string

Defined in: Interpreter/Response.ts:15

The cleaned message with all tags interpreted.


keyValues

keyValues: IKeyValues

Defined in: Interpreter/Response.ts:38


raw

raw: string

Defined in: Interpreter/Response.ts:10

The raw string that was used to generate this response.


variables

variables: object

Defined in: Interpreter/Response.ts:20

An object with all the variables that parsers such as the LooseVarsParser can access.

Index Signature

[key: string]: ITransformer

Methods

setValues()

setValues(output, raw): Response

Defined in: Interpreter/Response.ts:47

Parameters

output

string

raw

string

Returns

Response


toJSON()

toJSON(): object

Defined in: Interpreter/Response.ts:55

Returns

object

actions

actions: IActions

body

body: null | string

keyValues

keyValues: IKeyValues

raw

raw: string

variables

variables: object

Index Signature

[key: string]: ITransformer

On this page