Class TextWriter

Hierarchy

AbstractWriter
- TextWriter
  - PrettyTextWriter

Index

Constructors

constructor

Accessors

isTopLevel

Constructors

constructor

new TextWriter(writeable: Writeable): TextWriter

Overrides AbstractWriter.constructor
- Defined in src/IonTextWriter.ts:56
Parameters
- writeable: Writeable
Returns TextWriter

Accessors

isTopLevel

get isTopLevel(): boolean

- Defined in src/IonTextWriter.ts:63
Returns boolean

Methods

addAnnotation

addAnnotation(annotation: string): void

Inherited from AbstractWriter.addAnnotation
- Defined in src/AbstractWriter.ts:27
Parameters
- annotation: string
Returns void

close

close(): void

Overrides AbstractWriter.close
- Defined in src/IonTextWriter.ts:350
Returns void

depth

depth(): number

Overrides AbstractWriter.depth
- Defined in src/IonTextWriter.ts:359
Returns number

getBytes

getBytes(): Uint8Array

Overrides AbstractWriter.getBytes
- Defined in src/IonTextWriter.ts:105
Returns Uint8Array

setAnnotations

setAnnotations(annotations: string[]): void

Inherited from AbstractWriter.setAnnotations
- Defined in src/AbstractWriter.ts:34
Parameters
- annotations: string[]
Returns void

stepIn

stepIn(type: IonType): void

Overrides AbstractWriter.stepIn
- Defined in src/IonTextWriter.ts:291
Parameters
- type: IonType
Returns void

stepOut

stepOut(): void

Overrides AbstractWriter.stepOut
- Defined in src/IonTextWriter.ts:325
Returns void

writeBlob

writeBlob(value: Uint8Array): void

Overrides AbstractWriter.writeBlob
- Defined in src/IonTextWriter.ts:109
Parameters
- value: Uint8Array
Returns void

writeBoolean

writeBoolean(value: boolean): void

Overrides AbstractWriter.writeBoolean
- Defined in src/IonTextWriter.ts:116
Parameters
- value: boolean
Returns void

writeClob

writeClob(value: Uint8Array): void

Overrides AbstractWriter.writeClob
- Defined in src/IonTextWriter.ts:123
Parameters
- value: Uint8Array
Returns void

writeDecimal

writeDecimal(value: Decimal): void

Overrides AbstractWriter.writeDecimal
- Defined in src/IonTextWriter.ts:155
Parameters
- value: Decimal
Returns void

writeFieldName

writeFieldName(fieldName: string): void

Overrides AbstractWriter.writeFieldName
- Defined in src/IonTextWriter.ts:212
Parameters
- fieldName: string
Returns void

writeFloat32

writeFloat32(value: number): void

Overrides AbstractWriter.writeFloat32
- Defined in src/IonTextWriter.ts:231
Parameters
- value: number
Returns void

writeFloat64

writeFloat64(value: number): void

Overrides AbstractWriter.writeFloat64
- Defined in src/IonTextWriter.ts:236
Parameters
- value: number
Returns void

writeInt

writeInt(value: number | bigint): void

Overrides AbstractWriter.writeInt
- Defined in src/IonTextWriter.ts:241
Parameters
- value: number | bigint
Returns void

writeNull

writeNull(type: IonType): void

Overrides AbstractWriter.writeNull
- Defined in src/IonTextWriter.ts:256
Parameters
- type: IonType
Returns void

writeString

writeString(value: string): void

Overrides AbstractWriter.writeString
- Defined in src/IonTextWriter.ts:268
Parameters
- value: string
Returns void

writeSymbol

writeSymbol(value: string): void

Overrides AbstractWriter.writeSymbol
- Defined in src/IonTextWriter.ts:277
Parameters
- value: string
Returns void

writeTimestamp

writeTimestamp(value: Timestamp): void

Overrides AbstractWriter.writeTimestamp
- Defined in src/IonTextWriter.ts:284
Parameters
- value: Timestamp
Returns void

writeValue

writeValue(reader: Reader): void

Inherited from AbstractWriter.writeValue
- Defined in src/AbstractWriter.ts:52
Parameters
- reader: Reader
Returns void

writeValues

writeValues(reader: Reader): void

Inherited from AbstractWriter.writeValues
- Defined in src/AbstractWriter.ts:48
Parameters
- reader: Reader
Returns void