Class jsstp_t

jsstp object

See

Alias

jsstp.type

Example

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

Hierarchy (view full)

jsstp_t
- jsstp_with_ghost_info_t

Indexable

[key: `On${string}`]: simple_event_caller

Matches event names to generate a simple invoker

Group

Index reflections

Example

let data=await jsstp.OnTest(123,"abc");

Index

Constructors

constructor

new jsstp_t(sender_name?, host?): jsstp_t
Basic jsstp object
Parameters
- Optional sender_name: String
  The name of the sender when the object interacts with the server
- Optional host: String
  Target server address
Returns jsstp_t
- Defined in types/jsstp_t.d.ts:282

Properties

RequestHeader

RequestHeader: {
[key: string]: string;
}

The header used in fecth.

Type declaration

[key: string]: string

default_info

default_info: base_sstp_content_t

Default Message Content

default_security_level

default_security_level: security_level_t

Queries the default security level, which is "local" in nodejs and "external" in browsers.

See

https://www.google.com/search?q=site%3Assp.shillest.net%2Fukadoc%2F+SecurityLevel

proxy

proxy: jsstp_t

Self Proxy

sstp_version_table

sstp_version_table: {
[method: string]: Number;
}

SSTP protocol version number list

Type declaration

[method: string]: Number

host

get host(): string
Returns string
- Defined in types/jsstp_t.d.ts:289
set host(host): void
Modify host
Parameters
- host: string
Returns void
- Defined in types/jsstp_t.d.ts:288

sendername

get sendername(): String
Returns String
- Defined in types/jsstp_t.d.ts:296
set sendername(sender_name): void
Modify sendername
Parameters
- sender_name: String
Returns void
- Defined in types/jsstp_t.d.ts:295

Methods

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.");

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) => 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>>
- Defined in types/jsstp_t.d.ts:316

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) => result_T)
  Operator function
  - - (jsstp): result_T
    - Parameters
      jsstp: jsstp_with_ghost_info_t
      Returns result_T
Returns Promise<info_object<string, result_T>>
- Defined in types/jsstp_t.d.ts:321

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);
```
- Defined in types/jsstp_t.d.ts:490

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));

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
}

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
Optional security_level: security_level_t
security_level

Returns Promise<Boolean>

whether or not it exists

Example

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

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
}

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)
    )
);
```
- Defined in types/jsstp_t.d.ts:526

Basic Send Methods

costom_text_send

costom_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.
- Defined in types/jsstp_t.d.ts:337

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) => 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
- Defined in types/jsstp_t.d.ts:346

row_send

row_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.
- Defined in types/jsstp_t.d.ts:329

Caller Methods

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
- Optional method_caller: method_caller<T, [Res]>
  Method invoker
- Optional args_processor: ((...args) => Res)
  Argument processor
  - - (...args): Res
    - Parameters
      Rest ...args: Rest
      Returns Res
Returns base_keyed_method_caller<T, Rest>
The invoker
- Defined in types/jsstp_t.d.ts:368

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
- Optional result_type: (new (str) => T)
  The type of the result, defaults to sstp_info_t
  - - new (str): T
    - Parameters
      str: string
      Returns T
- Optional args_processor: ((...args) => 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
- Defined in types/jsstp_t.d.ts:356

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
- Optional method_caller: method_caller<T, [Object]>
  Method invoker
Returns simple_keyed_method_caller<T>
The invoker
- Defined in types/jsstp_t.d.ts:382

Clone Methods

clone

get clone(): jsstp_t
Copy a new jsstp object

Returns jsstp_t
- Defined in types/jsstp_t.d.ts:302

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
- Defined in types/jsstp_t.d.ts:310

Indexer Members

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();
```
- Defined in types/jsstp_t.d.ts:403

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");
```
- Defined in types/jsstp_t.d.ts:393

PromiseLike Methods

if_available

if_available<result_T>(resolve): Promise<result_T>
Get whether ghost is currently available
Type Parameters
- result_T = undefined
Parameters
- resolve: ((value?) => result_T)
  Functions executed when ghost is available
  - - (value?): result_T
    - Parameters
      Optional value: 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
});
```
Example
```
xxx.then(v => jsstp.if_available()).then(() => {
    //do something
});
```
- Defined in types/jsstp_t.d.ts:515

SSTP Base Methods

COMMUNICATE

COMMUNICATE: method_caller<sstp_info_t, [common_communicate_sstp_content_t]>

EXECUTE

EXECUTE: method_caller<sstp_info_t, [common_execute_sstp_content_t]>

GIVE

GIVE: method_caller<sstp_info_t, [common_give_sstp_content_t]>

NOTIFY

NOTIFY: method_caller<sstp_info_t, [common_event_sstp_content_t]>

SEND

SEND: method_caller<sstp_info_t, [common_event_sstp_content_t]>

Types

base_sstp_info_t

base_sstp_info_t: typeof base_sstp_info_t

fmo_info_t

fmo_info_t: typeof fmo_info_t

ghost_events_queryer_t

ghost_events_queryer_t: typeof ghost_events_queryer_t

list_info_t

list_info_t: typeof list_info_t

sstp_info_t

sstp_info_t: typeof sstp_info_t

type

type: typeof jsstp_t

Class jsstp_t

See

Alias

Example

Hierarchy (view full)

Indexable

Group

Example

Index

Constructors

Properties

Methods

Basic Send Methods

Caller Methods

Clone Methods

Indexer Members

PromiseLike Methods

SSTP Base Methods

Types

Constructors

constructor

Parameters

Returns jsstp_t

Properties

RequestHeader

Type declaration

[key: string]: string

default_info

default_security_level

See

proxy

sstp_version_table

Type declaration

[method: string]: Number

host

Returns string

Parameters

Returns void

sendername

Returns String

Parameters

Returns void

Methods

available

Returns Promise<Boolean>

Example

for_all_ghost_infos

Type Parameters

Parameters

Parameters

Returns result_T

Returns Promise<info_object<string, result_T>>

for_all_ghosts

Type Parameters

Parameters

Parameters

Returns result_T

Returns Promise<info_object<string, result_T>>

get_fmo_infos

Returns Promise<fmo_info_t>

Example

get_supported_events

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

Example

Example

has_event

Parameters

Returns Promise<Boolean>

Example

Example

new_event_queryer

Returns Promise<ghost_events_queryer_t>

Example

Basic Send Methods

costom_text_send

Parameters

Returns Promise<String>

custom_send

Type Parameters

Parameters

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

Returns {
[command_name: string]: simple_command_caller;
}

Returns {
[event_name: string]: simple_event_caller;
}