Class fmo_info_t

fmo message class

Example

let fmo = jsstp.get_fmo_infos();
let kikka_uuid = fmo.get_uuid_by("name", "橘花");
if(kikka_uuid)
	console.log(fmo[kikka_uuid].ghostpath);

Alias

jsstp.fmo_info_t

See

Hierarchy (view full)

Indexable

  • [uuid: `some ${string}`]: single_fmo_info_t | undefined

    fmo members

Constructors

constructor

Accessors

available entries head keys length status_code text_content trivial_clone unknown_lines uuids values

Methods

flat_map forEach get_list_of get_uuid_by map push

Constructors

constructor

Accessors

available

entries

  • get entries(): [key_T, value_T][]

  • Get an array of all key-value pairs.

    Returns [key_T, value_T][]

head

  • get head(): String

  • Get the header of the message

    Returns String

    message header

keys

  • get keys(): key_T[]

  • Get an array of all keys

    Returns key_T[]

length

  • get length(): number

  • Get the number of members

    Returns number

status_code

  • get status_code(): sstp_return_code_t

  • Get header return code (NaN if unexpected)

    Returns sstp_return_code_t

    header return code (NaN if unexpected)

text_content

  • get text_content(): String

  • Getting a String Message

    Returns String

    String message.

trivial_clone

  • get trivial_clone(): info_object<key_T, value_T>

  • Copy a new object

    Returns info_object<key_T, value_T>

    Copied object

unknown_lines

  • get unknown_lines(): String[]

  • Get array of unknown rows

    Returns String[]

    array of unknown rows

uuids

values

  • get values(): value_T[]

  • Get an array of all values

    Returns value_T[]

Methods

flat_map

  • flat_map<T>(func): T[]

  • Traverses itself and its children and returns a one-dimensional array of traversal results.

    Type Parameters

    • T

    Parameters

    • func: ((...dimensions_with_value_in_last: [...string[], single_fmo_info_t]) => T)

      Function to execute, the return value will be added to the array.

        • (...dimensions_with_value_in_last): T

        • Parameters

          • Rest...dimensions_with_value_in_last: [...string[], single_fmo_info_t]

          Returns T

    Returns T[]

forEach

  • forEach(func): void

  • Execute a function for each key-value pair.

    Parameters

    • func: ((value: single_fmo_info_t, key?: string) => single_fmo_info_t)

      A function to be executed that replaces value if the return value is not undefined.

        • (value, key?): single_fmo_info_t

        • Parameters

          • value: single_fmo_info_t
          • Optionalkey: string

          Returns single_fmo_info_t

    Returns void

get_list_of

  • get_list_of(name): String[]

  • Gets the values of all the specified properties

    Parameters

    • name: String

    Returns String[]

    Example

    let ghost_list = fmo_info.get_list_of("name");

    Description

    Equivalent to this.uuids.map(uuid => this[uuid][name])

get_uuid_by

  • get_uuid_by(name, value): String

  • Get the uuid of the fmo with the specified attribute and the value of the attribute is the specified value

    Parameters

    • name: String

      The name of the property to be checked.

    • value: String

      The value of the property to be checked.

    Returns String

    corresponding uuid (if any)

    Example

    let kikka_uuid = fmo_info.get_uuid_by("name", "橘花");

    Description

    Equivalent to this.uuids.find(uuid => this[uuid][name] == value)

map

  • map<T>(func): T[]

  • Traverses itself and returns a one-dimensional array of traversal results.

    Type Parameters

    • T

    Parameters

    • func: ((value: single_fmo_info_t, key?: string) => T)

      Function to execute, the return value will be added to the array.

        • (value, key?): T

        • Parameters

          • value: single_fmo_info_t
          • Optionalkey: string

          Returns T

    Returns T[]

push

Settings

Member Visibility

On This Page

constructoravailableentriesheadkeyslengthstatus_codetext_contenttrivial_cloneunknown_linesuuidsvaluesflat_mapforEachget_list_ofget_uuid_bymappush