diff --git a/CHANGELOG.md b/CHANGELOG.md index 45877ea..ce91c9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,13 @@ -# 3.1.0 / 2022-06-22 +# 3.1.1 / 2022-06-22 ## :tada: Enhancements - Updated code style + +# 3.1.0 / 2022-06-22 + +## :tada: Enhancements + - Updated libraries - Fixes for node 18 and new versions of libraries diff --git a/docs/classes/classes_parser.parser.html b/docs/classes/classes_parser.parser.html index 13373f9..a508ddf 100644 --- a/docs/classes/classes_parser.parser.html +++ b/docs/classes/classes_parser.parser.html @@ -1,22 +1,22 @@ -Parser | ObjectStream - v3.1.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Parser

Hierarchy

  • Transform
    • Parser

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Parser(start?: string, middle?: string, end?: string): Parser

Properties

Private __buffers

__buffers: Buffer[]

stream buffer

-

Private __bytesRead

__bytesRead: number
+

Private __bytesRead

__bytesRead: number

stream byte counter

-

Private __encoding

__encoding: "utf8" | "utf-8" | "base64" | "latin1" | "binary" | "hex"
+

Private __encoding

__encoding: "utf8" | "utf-8" | "base64" | "latin1" | "binary" | "hex"

stream encoding

-

Private __leftBrace

__leftBrace: number
+

Private __leftBrace

__leftBrace: number

left brace counter

-

Private __openQuotes

__openQuotes: boolean
+

Private __openQuotes

__openQuotes: boolean

open quote flag

-

Private __rightBrace

__rightBrace: number
+

Private __rightBrace

__rightBrace: number

right brace counter

-

Private __separators

__separators: { end: number; middle: number; start: number }
+

Private __separators

__separators: { end: number; middle: number; start: number }

separators

Type declaration

  • end: number
  • middle: number
  • start: number

allowHalfOpen

allowHalfOpen: boolean

If false then the stream will automatically end the writable side when the @@ -59,7 +59,7 @@

Readonly readableObjectMode

readableObjectMode: boolean

Getter for the property objectMode of a given Readable stream.

since

v12.3.0

-

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Static Private __empty

__empty: Buffer = ...
+

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Static Private __empty

__empty: Buffer = ...

empty buffer

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

@@ -70,19 +70,19 @@

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

Private __clear

  • __clear(): void

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

Private __clear

  • __clear(): void

Private __handler

  • __handler(buffer: Buffer, s: number, errors: Error[]): void

Private __handler

  • __handler(buffer: Buffer, s: number, errors: Error[]): void

Optional _construct

  • _construct(callback: ((error?: null | Error) => void)): void

  • Parameters

    • callback: ((error?: null | Error) => void)
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error: null | Error, callback: ((error: null | Error) => void)): void

  • Parameters

    • error: null | Error
    • callback: ((error: null | Error) => void)
        • (error: null | Error): void

        • Parameters

          • error: null | Error

          Returns void

    Returns void

Private _final

  • _final(callback?: Function): void

Optional _construct

  • _construct(callback: ((error?: null | Error) => void)): void

  • Parameters

    • callback: ((error?: null | Error) => void)
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error: null | Error, callback: ((error: null | Error) => void)): void

  • Parameters

    • error: null | Error
    • callback: ((error: null | Error) => void)
        • (error: null | Error): void

        • Parameters

          • error: null | Error

          Returns void

    Returns void

Private _final

  • _final(callback?: Function): void

  • End event handler

    Parameters

    • callback: Function = ...

      callback function

      -

    Returns void

Private _flush

  • _flush(callback?: Function): void

Returns void

Private _flush

  • _flush(callback?: Function): void

  • Flush event handler

    Parameters

    • callback: Function = ...

      callback function

      -

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

Private _transform

  • _transform(string: undefined | null | string | Buffer, encoding?: BufferEncoding, callback?: Function): void

Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

Private _transform

  • _transform(string: undefined | null | string | Buffer, encoding?: BufferEncoding, callback?: Function): void

  • Data event handler

    Parameters

    • string: undefined | null | string | Buffer

      string or buffer data

      @@ -208,7 +208,7 @@

      The readable.resume() method has no effect if there is a 'readable'event listener.

      since

      v0.9.4

      -

      Returns Parser

setDefaultEncoding

  • setDefaultEncoding(encoding: BufferEncoding): Parser

  • Parameters

    • encoding: BufferEncoding

    Returns Parser

setEncoding

  • setEncoding(encoding: "utf8" | "utf-8" | "base64" | "latin1" | "binary" | "hex"): Parser

setDefaultEncoding

  • setDefaultEncoding(encoding: BufferEncoding): Parser

  • Parameters

    • encoding: BufferEncoding

    Returns Parser

setEncoding

  • setEncoding(encoding: "utf8" | "utf-8" | "base64" | "latin1" | "binary" | "hex"): Parser

  • set stream encoding

    Parameters

    • encoding: "utf8" | "utf-8" | "base64" | "latin1" | "binary" | "hex"

    Returns Parser

setMaxListeners

  • setMaxListeners(n: number): Parser

Private _flush

  • _flush(callback?: (() => void)): void

  • Flush event handler

    Parameters

    • callback: (() => void) = ...

      callback function

      -
        • (): void

        • Returns void

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

Private _transform

  • _transform(object: undefined | null | {}, encoding?: BufferEncoding, callback?: Function): void

Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

Private _transform

  • _transform(object: undefined | null | {}, encoding?: BufferEncoding, callback?: Function): void

  • Data event handler

    Parameters

    • object: undefined | null | {}

      object data

      @@ -196,7 +196,7 @@

      The readable.resume() method has no effect if there is a 'readable'event listener.

      since

      v0.9.4

      -

      Returns Stringifer

setDefaultEncoding

  • setDefaultEncoding(encoding: BufferEncoding): Stringifer

  • Parameters

    • encoding: BufferEncoding

    Returns Stringifer

setEncoding

  • setEncoding(encoding: "utf8" | "utf-8" | "base64" | "latin1" | "binary" | "hex"): Stringifer

setDefaultEncoding

  • setDefaultEncoding(encoding: BufferEncoding): Stringifer

  • Parameters

    • encoding: BufferEncoding

    Returns Stringifer

setEncoding

  • setEncoding(encoding: "utf8" | "utf-8" | "base64" | "latin1" | "binary" | "hex"): Stringifer

setMaxListeners

  • By default EventEmitters will print a warning if more than 10 listeners are diff --git a/docs/modules/utils_global.html b/docs/modules/utils_global.html index 6fd8051..b64ae30 100644 --- a/docs/modules/utils_global.html +++ b/docs/modules/utils_global.html @@ -1,4 +1,4 @@ -utils/global | ObjectStream - v3.1.1

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module utils/global

    Index

    Functions

    Functions

    Private validator

    • validator(obj: any, it?: boolean): boolean