Class Response

SHIORI Response Message Headers Container

Hierarchy

Headers
- Response

Index

Constructors

constructor

Properties

header

Accessors

Constructors

constructor

new Response(header?: object): Response

Inherited from Headers.constructor
- Defined in lib/shiorijk.ts:440
initialize headers

Parameters
- Default value header: object = {}
  
  headers
  - [name: string]: string
Returns Response

Properties

header

header: object

headers

Type declaration

[name: string]: string | undefined

Accessors

BalloonOffset

get BalloonOffset(): number[][]
set BalloonOffset(value: number[][]): void

- Defined in lib/shiorijk.ts:823
BalloonOffset header (SHIORI/2.0)

Returns number[][]
- Defined in lib/shiorijk.ts:827
BalloonOffset header (SHIORI/2.0)

Parameters
- value: number[][]
Returns void

Sentence

get Sentence(): undefined | string
set Sentence(value: undefined | string): void

- Defined in lib/shiorijk.ts:841
Sentence header (SHIORI/2.0,2.2,2.3b,2.4)

Returns undefined | string
- Defined in lib/shiorijk.ts:845
Sentence header (SHIORI/2.0,2.2,2.3b,2.4)

Parameters
- value: undefined | string
Returns void

Status

get Status(): number[]
set Status(value: number[]): void

- Defined in lib/shiorijk.ts:859
Status header (GET Status SHIORI/2.0)

Returns number[]
- Defined in lib/shiorijk.ts:863
Status header (GET Status SHIORI/2.0)

Parameters
- value: number[]
Returns void

String

get String(): undefined | string
set String(value: undefined | string): void

- Defined in lib/shiorijk.ts:868
String header (GET String SHIORI/2.5)

Returns undefined | string
- Defined in lib/shiorijk.ts:872
String header (GET String SHIORI/2.5)

Parameters
- value: undefined | string
Returns void

Surface

get Surface(): number[]
set Surface(value: number[]): void

- Defined in lib/shiorijk.ts:832
Surface header (SHIORI/2.3b)

Returns number[]
- Defined in lib/shiorijk.ts:836
Surface header (SHIORI/2.3b)

Parameters
- value: number[]
Returns void

Value

get Value(): undefined | string
set Value(value: undefined | string): void

- Defined in lib/shiorijk.ts:877
Value header (GET SHIORI/3.0)

Returns undefined | string
- Defined in lib/shiorijk.ts:881
Value header (GET SHIORI/3.0)

Parameters
- value: undefined | string
Returns void

Word

get Word(): undefined | string
set Word(value: undefined | string): void

- Defined in lib/shiorijk.ts:850
Word header (GET Word SHIORI/2.0)

Returns undefined | string
- Defined in lib/shiorijk.ts:854
Word header (GET Word SHIORI/2.0)

Parameters
- value: undefined | string
Returns void

Methods

Reference

Reference(index: number): undefined | string

Inherited from Headers.Reference
- Defined in lib/shiorijk.ts:587
Reference* header (SHIORI/2.2-2.6,3.x)

Parameters
- index: number
  
  reference index
Returns undefined | string

header value

ReferenceSeparated

ReferenceSeparated(index: number, separator?: string): string[]

Inherited from Headers.ReferenceSeparated
- Defined in lib/shiorijk.ts:597
Reference* header (SHIORI/2.2-2.6,3.x)

Parameters
- index: number
  
  reference index
- Default value separator: string = ""
  
  separator characters
Returns string[]

header values

ReferenceSeparated2

ReferenceSeparated2(index: number, separator1?: string, separator2?: string): string[][]

Inherited from Headers.ReferenceSeparated2
- Defined in lib/shiorijk.ts:608
Reference* header (SHIORI/2.2-2.6,3.x)

Parameters
- index: number
  
  reference index
- Default value separator1: string = ""
  
  first level separator characters
- Default value separator2: string = ""
  
  second level separator characters
Returns string[][]

header values

StringSeparated

StringSeparated(separator?: string): string[]

- Defined in lib/shiorijk.ts:747
String header (GET String SHIORI/2.5)

Parameters
- Default value separator: string = ""
  
  separator characters
Returns string[]

header values

StringSeparated2

StringSeparated2(separator1?: string, separator2?: string): string[][]

- Defined in lib/shiorijk.ts:767
String header (GET String SHIORI/2.5)

Parameters
- Default value separator1: string = ""
  
  first level separator characters
- Default value separator2: string = ""
  
  second level separator characters
Returns string[][]

header values

ValueSeparated

ValueSeparated(separator?: string): string[]

- Defined in lib/shiorijk.ts:787
Value header (GET SHIORI/3.0)

Parameters
- Default value separator: string = ""
  
  separator characters
Returns string[]

header values

ValueSeparated2

ValueSeparated2(separator1?: string, separator2?: string): string[][]

- Defined in lib/shiorijk.ts:807
Value header (GET SHIORI/3.0)

Parameters
- Default value separator1: string = ""
  
  first level separator characters
- Default value separator2: string = ""
  
  second level separator characters
Returns string[][]

header values

get

get(name: string): undefined | string

Inherited from Headers.get
- Defined in lib/shiorijk.ts:455
get header

Parameters
- name: string
  
  header name
Returns undefined | string

header value

get_separated

get_separated(name: string, separator?: string): undefined | string[]

Inherited from Headers.get_separated
- Defined in lib/shiorijk.ts:483
get header separated by \x01 or some as an array

Parameters
- name: string
  
  header name
- Default value separator: string = ""
  
  separator characters
Returns undefined | string[]

header values

get_separated2

get_separated2(name: string, separator1?: string, separator2?: string): undefined | string[][]

Inherited from Headers.get_separated2
- Defined in lib/shiorijk.ts:510
get header separated by \x02 and \x01 or some as an array

Parameters
- name: string
  
  header name
- Default value separator1: string = ""
  
  first level separator characters
- Default value separator2: string = ""
  
  second level separator characters
Returns undefined | string[][]

header values

references

references(): (undefined | string)[]

Inherited from Headers.references
- Defined in lib/shiorijk.ts:535
get Reference* headers

Returns (undefined | string)[]

Reference* header values

set

set(name: string, value: string | undefined): undefined | string

Inherited from Headers.set
- Defined in lib/shiorijk.ts:467
set header

header will be deleted if value == undefined

Parameters
- name: string
  
  header name
- value: string | undefined
  
  header value
Returns undefined | string

header value

setStringSeparated

setStringSeparated(value: string[], separator?: string): string

- Defined in lib/shiorijk.ts:757
set String header (GET String SHIORI/2.5)

Parameters
- value: string[]
  
  header values
- Default value separator: string = ""
  
  separator characters
Returns string

header value

setStringSeparated2

setStringSeparated2(value: string[][], separator1?: string, separator2?: string): string

- Defined in lib/shiorijk.ts:778
set String header (GET String SHIORI/2.5)

Parameters
- value: string[][]
  
  header values
- Default value separator1: string = ""
  
  first level separator characters
- Default value separator2: string = ""
  
  second level separator characters
Returns string

header value

setValueSeparated

setValueSeparated(value: string[], separator?: string): string

- Defined in lib/shiorijk.ts:797
set Value header (GET SHIORI/3.0)

Parameters
- value: string[]
  
  header values
- Default value separator: string = ""
  
  separator characters
Returns string

header value

setValueSeparated2

setValueSeparated2(value: string[][], separator1?: string, separator2?: string): string

- Defined in lib/shiorijk.ts:818
set Value header (GET SHIORI/3.0)

Parameters
- value: string[][]
  
  header values
- Default value separator1: string = ""
  
  first level separator characters
- Default value separator2: string = ""
  
  second level separator characters
Returns string

header values

set_separated

set_separated(name: string, value: string[], separator?: string): string

Inherited from Headers.set_separated
- Defined in lib/shiorijk.ts:499
set header separated by \x01 or some as an array

Parameters
- name: string
  
  header name
- value: string[]
  
  header values
- Default value separator: string = ""
  
  separator characters
Returns string

header value

set_separated2

set_separated2(name: string, value: string[][], separator1?: string, separator2?: string): string

Inherited from Headers.set_separated2
- Defined in lib/shiorijk.ts:527
set header separated by \x02 and \x01 or some as an array

Parameters
- name: string
  
  header name
- value: string[][]
  
  header values
- Default value separator1: string = ""
  
  first level separator characters
- Default value separator2: string = ""
  
  second level separator characters
Returns string

header value

toString

toString(): string

Inherited from Headers.toString
- Defined in lib/shiorijk.ts:570
Message to string

Returns string

message string

validate

validate(): void

Inherited from Headers.validate
- Defined in lib/shiorijk.ts:556
check that headers are line feed free

throw

if not

Returns void

Generated using TypeDoc