Interface TwingOutputBuffer

Readonly outputStream

clean

• clean(): boolean

• Clean (erase) the output buffer

  In human terms: empties the top-most buffer

  ┌─────────┐ ┌─────────┐ │ oof │ │ │ ├─────────┤ ├─────────┤ │ bar │ => │ bar │ ├─────────┤ ├─────────┤ │ foo │ │ foo │ => true └─────────┘ └─────────┘

  Returns boolean

echo

• echo(string): string | void

• Parameters

  • string: any

  Returns string | void

endAndClean

• endAndClean(): boolean

• Clean the output buffer, and delete active output buffer

  In human terms: removes the top-most buffer

  ┌─────────┐
  │   oof   │
  ├─────────┤    ┌─────────┐
  │   bar   │ -> │   bar   │
  ├─────────┤    ├─────────┤
  │   foo   │    │   foo   │ => true
  └─────────┘    └─────────┘
  Copy

  Returns boolean

endAndFlush

• endAndFlush(): boolean

• Flush (send) the output buffer, and delete current output buffer

  In human terms: appends the top-most buffer to the second-top-most buffer and removes the top-most buffer

  ┌─────────┐
  │   oof   │
  ├─────────┤    ┌─────────┐
  │   bar   │ -> │  baroof │
  ├─────────┤    ├─────────┤
  │   foo   │    │   foo   │ => true
  └─────────┘    └─────────┘
  Copy

  Returns boolean

flush

• flush(): boolean

• Flush (send) contents of the output buffer. The last buffer content is sent to next buffer

  In human terms: appends the top-most buffer to the second-top-most buffer and empties the top-most buffer

  ┌─────────┐    ┌─────────┐
  │   oof   │    │         │
  ├─────────┤    ├─────────┤
  │   bar   │ => │  baroof │
  ├─────────┤    ├─────────┤
  │   foo   │    │   foo   │ => true
  └─────────┘    └─────────┘
  Copy

  Returns boolean

getAndClean

• getAndClean(): string

• Get active buffer contents and delete active output buffer

  In human terms: removes the top-most buffer and returns its content

  ┌─────────┐
  │   oof   │
  ├─────────┤    ┌─────────┐
  │   bar   │ -> │   bar   │
  ├─────────┤    ├─────────┤
  │   foo   │    │   foo   │ => "oof"
  └─────────┘    └─────────┘
  Copy

  Returns string

getAndFlush

• getAndFlush(): string

• Get active buffer contents, flush (send) the output buffer, and delete active output buffer

  In human terms: appends the top-most buffer to the second-top-most buffer, removes the top-most buffer and returns its content

  ┌─────────┐
  │   oof   │
  ├─────────┤    ┌─────────┐
  │   bar   │ -> │  baroof │
  ├─────────┤    ├─────────┤
  │   foo   │    │   foo   │ => oof
  └─────────┘    └─────────┘
  Copy

  Returns string

getContents

• getContents(): string

• Gets the contents of the output buffer without clearing it.

  In human terms: returns the content of the top-most buffer

  ┌─────────┐
  │   oof   │
  ├─────────┤
  │   bar   │
  ├─────────┤
  │   foo   │ => "oof"
  └─────────┘
  Copy

  Returns string

getLevel

• getLevel(): number

• Return the nesting level of the output buffering mechanism

  Returns number

start

• start(): boolean

• Turn on Output Buffering (specifying an optional output handler).

  Returns boolean