Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Shiorif

The convenient SHIORI Shared Library Interface

Hierarchy

  • EventEmitter
    • Shiorif

Index

Classes

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static Headers

Headers: {} | (undefined | string)[]

headers

array = Reference* / hash = general

Constructors

constructor

  • new Shiorif(shiori: Shiori, options?: { autoAdjustToResponseCharset?: undefined | false | true; autoConvertRequestVersion?: ShioriConverter.ShioriVersion; defaultHeaders?: undefined | {}; synchronized?: undefined | false | true }): Shiorif

  • Parameters

    • shiori: Shiori

      The instance of SHIORI Shared Library Interface

    • Default value options: { autoAdjustToResponseCharset?: undefined | false | true; autoConvertRequestVersion?: ShioriConverter.ShioriVersion; defaultHeaders?: undefined | {}; synchronized?: undefined | false | true } = {}

      options

      • Optional autoAdjustToResponseCharset?: undefined | false | true

        request charset header will be set to previous response charset

      • Optional autoConvertRequestVersion?: ShioriConverter.ShioriVersion

        requests will be converted to this version

      • Optional defaultHeaders?: undefined | {}

        default headers

      • Optional synchronized?: undefined | false | true

        synchronized mode

    Returns Shiorif

Properties

Private _autoAdjustToResponseCharset

_autoAdjustToResponseCharset: boolean

Private _autoConvertRequestVersion

_autoConvertRequestVersion: ShioriConverter.ShioriVersion

Private _defaultHeaders

_defaultHeaders: {}

Type declaration

  • [name: string]: string

Private Optional _lastResponseCharset

_lastResponseCharset: undefined | string

Private _requestParser

_requestParser: Parser

Private _responseParser

_responseParser: Parser

Private _shiori

_shiori: Shiori

Private _synchronized

_synchronized: boolean

Private lock

lock: Promise<void | number | ShioriTransaction> = Promise.resolve()

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

autoAdjustToResponseCharset

  • get autoAdjustToResponseCharset(): boolean
  • set autoAdjustToResponseCharset(enabled: boolean): void

  • request charset header will be set to previous response charset

    Returns boolean

  • request charset header will be set to previous response charset

    Parameters

    • enabled: boolean

    Returns void

autoConvertRequestVersion

  • get autoConvertRequestVersion(): "2.6" | "3.0" | "4.0"
  • set autoConvertRequestVersion(version: "2.6" | "3.0" | "4.0"): void

  • requests will be converted to this version

    Returns "2.6" | "3.0" | "4.0"

  • requests will be converted to this version

    Parameters

    • version: "2.6" | "3.0" | "4.0"

    Returns void

defaultHeaders

  • get defaultHeaders(): {}
  • set defaultHeaders(headers: {}): void

  • default headers

    Returns {}

    • [name: string]: string

  • default headers

    Parameters

    • headers: {}
      • [name: string]: string

    Returns void

shiori

  • get shiori(): Shiori

synchronized

  • get synchronized(): boolean
  • set synchronized(synchronized: boolean): void

Methods

Private _load

  • _load(dirpath: string): Promise<number>

Private _request

  • _request(request: string | Request, convert?: boolean): Promise<ShioriTransaction>

  • Parameters

    • request: string | Request
    • Default value convert: boolean = true

    Returns Promise<ShioriTransaction>

Private _unload

  • _unload(): Promise<number>

get3

  • get3(id: string, headers?: Headers, convert?: boolean): Promise<ShioriTransaction>

  • SHIORI/2.x/3.x request() by GET SHIORI/3.x request value

    Parameters

    • id: string

      id

    • Optional headers: Headers

      headers

    • Default value convert: boolean = true

      enable auto request version convert

    Returns Promise<ShioriTransaction>

    The SHIORI request transaction

getVersion2

  • getVersion2(headers?: Headers, convert?: boolean): Promise<ShioriTransaction>

  • SHIORI/2.x request() by GET Version SHIORI/2.x request value

    Parameters

    • Optional headers: Headers

      headers

    • Default value convert: boolean = true

      enable auto request version convert

    Returns Promise<ShioriTransaction>

    The SHIORI request transaction

load

  • load(dirpath: string): Promise<number>

  • SHIORI/2.x/3.x load()

    this emits load(dirpath), loaded(status) events.

    Parameters

    • dirpath: string

      The directory that SHIORI Shared Library is placed. The end character of dirpath must be the path separator (/ or \).

    Returns Promise<number>

    The status code

notify3

  • notify3(id: string, headers?: Headers, convert?: boolean): Promise<ShioriTransaction>

  • SHIORI/2.x/3.x request() by NOTIFY SHIORI/3.x request value

    Parameters

    • id: string

      id

    • Optional headers: Headers

      headers

    • Default value convert: boolean = true

      enable auto request version convert

    Returns Promise<ShioriTransaction>

    The SHIORI request transaction

request

  • request(request: string | Request, convert?: boolean): Promise<ShioriTransaction>

  • SHIORI/2.x/3.x request()

    this emits request(request), response(response) events.

    Parameters

    • request: string | Request

      The SHIORI Request

    • Default value convert: boolean = true

      enable auto request version convert

    Returns Promise<ShioriTransaction>

    The SHIORI request transaction

request2

  • request2(method: ShioriJK.Method, headers?: Headers, convert?: boolean): Promise<ShioriTransaction>

  • SHIORI/2.x/3.x request() by SHIORI/2.x request value

    Parameters

    • method: ShioriJK.Method

      method

    • Optional headers: Headers

      headers

    • Default value convert: boolean = true

      enable auto request version convert

    Returns Promise<ShioriTransaction>

    The SHIORI request transaction

request3

  • request3(method: ShioriJK.Method, id: string, headers?: Headers, convert?: boolean): Promise<ShioriTransaction>

  • SHIORI/2.x/3.x request() by SHIORI/3.x request value

    Parameters

    • method: ShioriJK.Method

      method

    • id: string

      id

    • Optional headers: Headers

      headers

    • Default value convert: boolean = true

      enable auto request version convert

    Returns Promise<ShioriTransaction>

    The SHIORI request transaction

unload

  • unload(): Promise<number>

  • SHIORI/2.x/3.x unload()

    this emits unload(), unloaded(status) events.

    Returns Promise<number>

    The status code

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static referencesFromArray

  • referencesFromArray(headersArray: (undefined | string)[]): {}

  • convert array values to Reference* hash

    Parameters

    • headersArray: (undefined | string)[]

      header array values

    Returns {}

    headers hash

    • [name: string]: string

Generated using TypeDoc