Class jsstp_t

constructor

• new jsstp_t(sender_name?, host?): jsstp_t

• Basic jsstp object

  Parameters

  • Optionalsender_name: String

    The name of the sender when the object interacts with the server
  • Optionalhost: String

    Target server address

  Returns jsstp_t

RequestHeader

default_info

default_security_level

proxy

sstp_version_table

host

• get host(): string

• Returns string

• set host(host): void

• Modify host

  Parameters

  • host: string

  Returns void

sendername

• get sendername(): String

• Returns String

• set sendername(sender_name): void

• Modify sendername

  Parameters

  • sender_name: String

  Returns void

available

• available(): Promise<Boolean>

• Get whether ghost is currently available

  Returns Promise<Boolean>

  whether ghost is available or not

  Example

  if(await jsstp.available())
  	//do something
  else
  	console.error("Ghost is not available, please check if ghost is running.");
  Copy

for_all_ghost_infos

• for_all_ghost_infos<result_T>(operation): Promise<info_object<string, result_T>>

• Processing of fmoinfo for all ghosts

  Type Parameters

  • result_T

  Parameters

  • operation: ((fmo_info: single_fmo_info_t) => result_T)

    Operator function

    • • (fmo_info): result_T

      • Parameters

        • fmo_info: single_fmo_info_t

        Returns result_T

  Returns Promise<info_object<string, result_T>>

for_all_ghosts

• for_all_ghosts<result_T>(operation): Promise<info_object<string, result_T>>

• Operate on all ghosts

  Type Parameters

  • result_T

  Parameters

  • operation: ((jsstp: jsstp_with_ghost_info_t) => result_T)

    Operator function

    • • (jsstp): result_T

      • Parameters

        • jsstp: jsstp_with_ghost_info_t

        Returns result_T

  Returns Promise<info_object<string, result_T>>

get_fmo_infos

• get_fmo_infos(): Promise<fmo_info_t>

• Getting fmo information

  Returns Promise<fmo_info_t>

  fmo information

  Example

  let fmo=await jsstp.get_fmo_infos();
  if(fmo.available)
  	console.log(fmo);
  Copy

get_supported_events

• get_supported_events(): Promise<{
      external: string[];
      local: string[];
  }>

• Getting supported events in an agreed structure requires ghost to support Get_Supported_Events events
  If unsure of ghost support, use ghost_events_queryer_t (obtained via jsstp_t.new_event_queryer) to query

  Returns Promise<{
      external: string[];
      local: string[];
  }>

  Object containing both local and external arrays

  Example

  jsstp.get_supported_events().then(result => console.log(result));
  Copy

  Example

  //sample code (AYA):
  SHIORI_EV.On_Get_Supported_Events: void {
  	_L=GETFUNCLIST('On')
  	_base_local_event_funcs=IARRAY
  	foreach _L;_func{
  		if SUBSTR(_func,2,1) == '_'
  			_func=SUBSTR(_func,3,STRLEN(_func))
  		_base_local_event_funcs,=_func
  	}
  	_L=GETFUNCLIST('SHIORI_EV.On')
  	foreach _L;_func{
  		if SUBSTR(_func,12,1) == '_'
  			_func=SUBSTR(_func,13,STRLEN(_func))
  		_base_local_event_funcs,=_func
  	}
  	SHIORI_FW.Make_X_SSTP_PassThru('local',ARRAYDEDUP(_base_local_event_funcs))
  	_L=GETFUNCLIST('ExternalEvent.On')
  	_base_external_event_funcs=IARRAY
  	foreach _L;_func{
  		if SUBSTR(_func,16,1) == '_'
  			_func=SUBSTR(_func,17,STRLEN(_func))
  		_base_external_event_funcs,=_func
  	}
  	_L=GETFUNCLIST('SHIORI_EV.ExternalEvent.On')
  	foreach _L;_func{
  		if SUBSTR(_func,26,1) == '_'
  			_func=SUBSTR(_func,27,STRLEN(_func))
  		_base_external_event_funcs,=_func
  	}
  	SHIORI_FW.Make_X_SSTP_PassThru('external',ARRAYDEDUP(_base_external_event_funcs))
  }
  SHIORI_EV.ExternalEvent.On_Get_Supported_Events{
  	SHIORI_EV.On_Get_Supported_Events
  }
  Copy

has_event

• has_event(event_name, security_level?): Promise<Boolean>

• Determine if an event exists
  Use ghost_events_queryer_t (obtained via jsstp_t.new_event_queryer) to query if it is likely to be called frequently

  Parameters

  • event_name: String

    event_name
  • Optionalsecurity_level: security_level_t

    security_level

  Returns Promise<Boolean>

  whether or not it exists

  Example

  jsstp.has_event("OnTest").then(result => console.log(result));
  Copy

  Example

  //sample code (AYA):
  SHIORI_EV.On_Has_Event : void {
  	_event_name=reference.raw[0]
  	_SecurityLevel=reference.raw[1]
  	if !_SecurityLevel
  		_SecurityLevel=SHIORI_FW.SecurityLevel
  	if SUBSTR(_event_name,0,2) != 'On'
  		_event_name='On_'+_event_name
  	_result=0
  	if TOLOWER(_SecurityLevel) == 'external'
  		_event_name='ExternalEvent.'+_event_name
  	_result=ISFUNC(_event_name)
  	if !_result
  		_result=ISFUNC('SHIORI_EV.'+_event_name)
  	SHIORI_FW.Make_X_SSTP_PassThru('Result',_result)
  }
  SHIORI_EV.ExternalEvent.On_Has_Event{
  	SHIORI_EV.On_Has_Event
  }
  Copy

new_event_queryer

• new_event_queryer(): Promise<ghost_events_queryer_t>

• Get a queryer for querying events supported by ghost

  Returns Promise<ghost_events_queryer_t>

  Query the queryer for supported events.

  Example

  jsstp.new_event_queryer().then(queryer =>
  	queryer.check_event("OnTest").then(result =>
  		console.log(result)
  	)
  );
  Copy

custom_send

• custom_send<T>(sstphead, info, result_type): Promise<T>

• Send a custom message

  Type Parameters

  • T

  Parameters

  • sstphead: String

    Message header
  • info: Object

    The body of the message.
  • result_type: (new (str: string) => T)

    The type of the result, defaults to sstp_info_t

    • • new (str): T

      • Parameters

        • str: string

        Returns T

  Returns Promise<T>

  Returns a promise

custom_text_send

• custom_text_send(sstphead, info): Promise<String>

• Sends the message, but does not process the returned results

  Parameters

  • sstphead: String

    The header of the message.
  • info: Object

    The body of the message.

  Returns Promise<String>

  Returns a promise.

raw_send

• raw_send(info): Promise<String>

• Sends a message in text and receives it back in text

  Parameters

  • info: any

    Message body (text)

  Returns Promise<String>

  Returns a promise.

get_caller_of_key

• get_caller_of_key<T, Rest, Res>(key_name, value_name, method_caller?, args_processor?): base_keyed_method_caller<T, Rest>

• Get the invoker of a specific key

  Type Parameters

  • T = sstp_info_t
  • Rest extends any[] = [Object]
  • Res = Object

  Parameters

  • key_name: String

    Key name
  • value_name: String

    Key value
  • Optionalmethod_caller: method_caller<T, [Res]>

    Method invoker
  • Optionalargs_processor: ((...args: Rest) => Res)

    Argument processor

    • • (...args): Res

      • Parameters

        • Rest...args: Rest

        Returns Res

  Returns base_keyed_method_caller<T, Rest>

  The invoker

get_caller_of_method

• get_caller_of_method<T, Rest, Res>(method_name, result_type?, args_processor?): method_caller<T, Rest>

• Get the invoker of a specific method

  Type Parameters

  • T = sstp_info_t
  • Rest extends any[] = [Object]
  • Res = Object

  Parameters

  • method_name: String

    The name of the method
  • Optionalresult_type: (new (str: string) => T)

    The type of the result, defaults to sstp_info_t

    • • new (str): T

      • Parameters

        • str: string

        Returns T

  • Optionalargs_processor: ((...args: Rest) => Res)

    Argument processor, defaults to returning the input argument directly

    • • (...args): Res

      • Parameters

        • Rest...args: Rest

        Returns Res

  Returns method_caller<T, Rest>

  The invoker

get_simple_caller_of_key

• get_simple_caller_of_key<T>(key_name, value_name, method_caller?): simple_keyed_method_caller<T>

• Get a simple invoker for a specific key

  Type Parameters

  • T = sstp_info_t

  Parameters

  • key_name: String

    Key name
  • value_name: String

    Key value
  • Optionalmethod_caller: method_caller<T, [Object]>

    Method invoker

  Returns simple_keyed_method_caller<T>

  The invoker

clone

• get clone(): jsstp_t

• Copy a new jsstp object

  Returns jsstp_t

by_fmo_info

• by_fmo_info(fmo_info): jsstp_with_ghost_info_t

• Copy a new jsstp object for the given fmo_info

  Parameters

  • fmo_info: single_fmo_info_t

    fmo_info of target ghost

  Returns jsstp_with_ghost_info_t

  New jsstp object pointing to target ghost

command

• get command(): {
      [command_name: string]: simple_command_caller;
  }

• Proxy to get the executor of a specific command

  Returns {
      [command_name: string]: simple_command_caller;
  }

  • [command_name: string]: simple_command_caller

  Example

  jsstp.command.GetFMO();
  Copy

event

• get event(): {
      [event_name: string]: simple_event_caller;
  }

• Proxy for a simple caller to get a specified event

  Returns {
      [event_name: string]: simple_event_caller;
  }

  • [event_name: string]: simple_event_caller

  Example

  jsstp.event.OnTest("test");
  Copy

if_available

• if_available<result_T>(resolve): Promise<result_T>

• Get whether ghost is currently available

  Type Parameters

  • result_T = undefined

  Parameters

  • resolve: ((value?: jsstp_t) => result_T)

    Functions executed when ghost is available

    • • (value?): result_T

      • Parameters

        • Optionalvalue: jsstp_t

        Returns result_T

  Returns Promise<result_T>

  whether ghost is available, if so, resolve with jsstp, otherwise reject.

  Example

  jsstp.if_available(() => {
  	//do something
  });
  Copy

  Example

  xxx.then(v => jsstp.if_available()).then(() => {
  	//do something
  });
  Copy

COMMUNICATE

EXECUTE

GIVE

NOTIFY

SEND

base_sstp_info_t

let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTP Client\r\nScript: \\h\\s0Testing!\\u\\s[10]It's a test.\r\nOption: notranslate\r\n\r\n");
console.log(info.head);//SSTP/1.4 200 OK
console.log(info.Option);//notranslate
Copy

fmo_info_t

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

ghost_events_queryer_t

let ghost_events_queryer = jsstp.new_event_queryer();
if(!ghost_events_queryer.available)
	console.log("Current ghost does not support event queries");
if(ghost_events_queryer.has_event("OnBoom"))
	jsstp.OnBoom();
Copy

list_info_t

let list = jsstp.GetNames();
for(let name of list)
	console.log(name);
Copy

sstp_info_t

let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTP Client\r\nScript: \\h\\s0Testing!\\u\\s[10]It's a test.\r\nOption: notranslate\r\n\r\n");
console.log(info.head);//SSTP/1.4 200 OK
console.log(info.Option);//notranslate
Copy

type

let my_jsstp=new jsstp.type("my_coooool_jsstp",sstp_server_url);
Copy