Class SocketComponent<P, S, SS>

Component using Socket API for communication.

Type Parameters

P = {}
S = {}
SS = any

Hierarchy (view full)

Component<P, S, SS>
- SocketComponent

Index

Constructors

constructor

new SocketComponent<P, S, SS>(props): SocketComponent<P, S, SS>
Type Parameters
- P = {}
- S = {}
- SS = any
Parameters
- props: P
Returns SocketComponent<P, S, SS>
Inherited from Component.constructor
- Defined in node_modules/@types/react/index.d.ts:1008
new SocketComponent<P, S, SS>(props, context): SocketComponent<P, S, SS>
Type Parameters
- P = {}
- S = {}
- SS = any
Parameters
- props: P
- context: any
Returns SocketComponent<P, S, SS>
Deprecated
See
React Docs
Inherited from Component.constructor
- Defined in node_modules/@types/react/index.d.ts:1013

Properties

`Protected`_mounted

_mounted: boolean

Indicates if the component is mounted.

`Protected`_socketRequest

_socketRequest: SocketRequest

Methods

`Protected`call

call<R>(event): Promise<R>
Calls the socket event.
Type Parameters
- R = any
Parameters
- event: string
  Name of the event.
Returns Promise<R>
Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:957
call<P, R>(event, data): Promise<R>
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
Returns Promise<R>
Typeparam
P Type of parameters.

Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:967
call<P, R>(event, data, timeout): Promise<R>
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
- timeout: number
  Timeout of the event.
Returns Promise<R>
Typeparam
P Type of parameters.

Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:978
call<P, R>(event, data, timeout, onProgress): Promise<R>
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
- timeout: number
  Timeout of the event.
- onProgress: ((progress: number) => void)
  Function called in the progress tick.
  - - (progress): void
    - Parameters
      progress: number
      Returns void
Returns Promise<R>
Typeparam
P Type of parameters.

Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:990

componentDidMount

componentDidMount(): void
Called immediately after a component is mounted. Setting state here will trigger re-rendering.

Returns void
Inherited from Component.componentDidMount
- Defined in src/app/index.d.ts:853

componentWillUnmount

componentWillUnmount(): void
Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns void
Inherited from Component.componentWillUnmount
- Defined in src/app/index.d.ts:855

`Protected`emit

emit(event): this
Emits the socket event. The response can be handled in the on method.
Parameters
- event: string
  Name of the event.
Returns this
Typeparam
P Type of parameters.
- Defined in src/app/index.d.ts:1103
emit(event, key): this
Emits the socket event. The response can be handled in the on method.
Parameters
- event: string
  Name of the event.
- key: string
  Socket event key.
Returns this
- Defined in src/app/index.d.ts:1110
emit<P>(event, key, data): this
Emits the socket event. The response can be handled in the on method.
Type Parameters
- P = any
Parameters
- event: string
  Name of the event.
- key: string
  Socket event key.
- data: P
  Event parameters.
Returns this
Typeparam
P Type of parameters.
- Defined in src/app/index.d.ts:1119
emit<P>(event, key, data, onProgress): this
Emits the socket event. The response can be handled in the on method.
Type Parameters
- P = any
Parameters
- event: string
  Name of the event.
- key: string
  Socket event key.
- data: P
  Event parameters.
- onProgress: ((progress: number) => void)
  Function called in the progress tick.
  - - (progress): void
    - Parameters
      progress: number
      Returns void
Returns this
Typeparam
P Type of parameters.
- Defined in src/app/index.d.ts:1129

getContext

getContext(): default
Gets the application context.

Returns default
Inherited from Component.getContext
- Defined in src/app/index.d.ts:860

`Protected`getEvents

getEvents(): {
    data?: {
        [key: string]: any;
    };
    emit?: boolean;
    name: string;
    state: keyof S;
}[]
Gets a list of events that are registered in on method after the component mount and saves the data to the component state.

Returns {
    data?: {
        [key: string]: any;
    };
    emit?: boolean;
    name: string;
    state: keyof S;
}[]
- Defined in src/app/index.d.ts:1134

getJSXText

getJSXText<T>(key): Element
Gets the text from the dictionary as JSX object. All HTML in the text is converted to JSX.
Type Parameters
- T = any
Parameters
- key: keyof T
  Key of the text in the dictionary.
Returns Element
Typeparam
T - Type of the dictionary object -> typeof { key: 'value' }.
Inherited from Component.getJSXText
- Defined in src/app/index.d.ts:884
getJSXText<T>(key, ...args): Element
Gets the text from the dictionary as JSX object. All HTML in the text is converted to JSX.
Type Parameters
- T = any
Parameters
- key: keyof T
  Key of the text in the dictionary.
- Rest...args: any[]
  Arguments for text format.
Returns Element
Typeparam
T - Type of the dictionary object -> typeof { key: 'value' }.
Inherited from Component.getJSXText
- Defined in src/app/index.d.ts:892

`Protected`getStateKey

getStateKey(): string
Gets the state key of the component instance. By default the method returns null. If it's overriden to return a string value the saveState and loadState are handled automatically in the component's lifecycle.

Returns string
Inherited from Component.getStateKey
- Defined in src/app/index.d.ts:919

getText

getText<T>(key): string
Gets the text from the dictionary.
Type Parameters
- T = any
Parameters
- key: keyof T
  Key of the text in the dictionary.
Returns string
Typeparam
T - Type of the dictionary object -> typeof { key: 'value' }.
Inherited from Component.getText
- Defined in src/app/index.d.ts:868
getText<T>(key, ...args): string
Gets the text from the dictionary.
Type Parameters
- T = any
Parameters
- key: keyof T
  Key of the text in the dictionary.
- Rest...args: any[]
  Arguments for text format.
Returns string
Typeparam
T - Type of the dictionary object -> typeof { key: 'value' }.
Inherited from Component.getText
- Defined in src/app/index.d.ts:876

`Protected`loadState

loadState(key): Promise<void>
Loads the state from the memory storage.
Parameters
- key: string
  State key of the component instance.
Returns Promise<void>
Inherited from Component.loadState
- Defined in src/app/index.d.ts:912

`Protected`on

on<R>(event, callback): this
Registers socket event listener. This method should be called in componentDidMount.
Type Parameters
- R = any
Parameters
- event: string
  Name of the event.
- callback: ((error?: any, data?: R) => void)
  Callback for the event.
  - - (error?, data?): void
    - Parameters
      Optionalerror: any
      Optionaldata: R
      Returns void
Returns this
- Defined in src/app/index.d.ts:948

`Protected`onPopState

onPopState(event): void
Method called after window.onpopstate event is triggered.
Parameters
- event: any
Returns void
Inherited from Component.onPopState
- Defined in src/app/index.d.ts:898

`Protected`onSocketError

onSocketError(error): void
Called if some socket error appears.
Parameters
- error: any
  Socket error.
Returns void
- Defined in src/app/index.d.ts:940

`Protected`onSocketStateChanged

onSocketStateChanged(state): void
Called if the socket changes its state.
Parameters
- state: SocketState
  Current state of the socket.
Returns void
- Defined in src/app/index.d.ts:933

`Protected`request

request<R>(event, callback): this
Calls the socket event.
Type Parameters
- R = any
Parameters
- event: string
  Name of the event.
- callback: ((error?: any, data?: R) => void)
  Callback function.
  - - (error?, data?): void
    - Parameters
      Optionalerror: any
      Optionaldata: R
      Returns void
Returns this
Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:1048
request<P, R>(event, data, callback): this
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
- callback: ((error?: any, data?: R) => void)
  Callback function.
  - - (error?, data?): void
    - Parameters
      Optionalerror: any
      Optionaldata: R
      Returns void
Returns this
Typeparam
P Type of parameters.

Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:1059
request<P, R>(event, data, timeout, callback): this
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
- timeout: number
  Timeout of the event.
- callback: ((error?: any, data?: R) => void)
  Callback function.
  - - (error?, data?): void
    - Parameters
      Optionalerror: any
      Optionaldata: R
      Returns void
Returns this
Typeparam
P Type of parameters.

Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:1071
request<P, R>(event, data, timeout, callback, onProgress): this
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
- timeout: number
  Timeout of the event.
- callback: ((error?: any, data?: R) => void)
  Callback function.
  - - (error?, data?): void
    - Parameters
      Optionalerror: any
      Optionaldata: R
      Returns void
- onProgress: ((progress: number) => void)
  Function called in the progress tick.
  - - (progress): void
    - Parameters
      progress: number
      Returns void
Returns this
Typeparam
P Type of parameters.

Typeparam
R Type of response.

Deprecated
- Defined in src/app/index.d.ts:1089

`Protected`requestAsync

requestAsync<R>(event): Promise<R>
Calls the socket event.
Type Parameters
- R = any
Parameters
- event: string
  Name of the event.
Returns Promise<R>
Typeparam
R Type of response.
- Defined in src/app/index.d.ts:1003
requestAsync<P, R>(event, data): Promise<R>
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
Returns Promise<R>
Typeparam
P Type of parameters.

Typeparam
R Type of response.
- Defined in src/app/index.d.ts:1012
requestAsync<P, R>(event, data, timeout): Promise<R>
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
- timeout: number
  Timeout of the event.
Returns Promise<R>
Typeparam
P Type of parameters.

Typeparam
R Type of response.
- Defined in src/app/index.d.ts:1022
requestAsync<P, R>(event, data, timeout, onProgress): Promise<R>
Calls the socket event.
Type Parameters
- P = any
- R = any
Parameters
- event: string
  Name of the event.
- data: P
  Event parameters.
- timeout: number
  Timeout of the event.
- onProgress: ((progress: number) => void)
  Function called in the progress tick.
  - - (progress): void
    - Parameters
      progress: number
      Returns void
Returns Promise<R>
Typeparam
P Type of parameters.

Typeparam
R Type of response.
- Defined in src/app/index.d.ts:1033

`Protected`saveState

saveState(key): void
Saves the current state to the memory storage.
Parameters
- key: string
  State key of the component instance.
Returns void
Inherited from Component.saveState
- Defined in src/app/index.d.ts:905

Class SocketComponent<P, S, SS>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SocketComponent<P, S, SS>

Type Parameters

Parameters

Returns SocketComponent<P, S, SS>

Deprecated

See

Properties

Protected_mounted

Protected_socketRequest

Methods

Protectedcall

Type Parameters

Parameters

Returns Promise<R>

Typeparam

Deprecated

Type Parameters

Parameters

Returns Promise<R>

Typeparam

Typeparam

Deprecated

Type Parameters

Parameters

Returns Promise<R>

Typeparam

Typeparam

Deprecated

Type Parameters

Parameters

Parameters

Returns void

Returns Promise<R>

Typeparam

Typeparam

Deprecated

componentDidMount

Returns void

componentWillUnmount

Returns void

Protectedemit

Parameters

Returns this

Typeparam

Parameters

Returns this

Type Parameters

Parameters

Returns this

Typeparam

Type Parameters

Parameters

Parameters

Returns void

Returns this

Typeparam

getContext

Returns default

ProtectedgetEvents

Returns { data?: { [key: string]: any; }; emit?: boolean; name: string; state: keyof S; }[]

getJSXText

Type Parameters

Parameters

Returns Element

Typeparam

Type Parameters

Parameters

Returns Element

Typeparam

`Protected`_mounted

`Protected`_socketRequest

`Protected`call

`Protected`emit

`Protected`getEvents

Returns {
data?: {
[key: string]: any;
};
emit?: boolean;
name: string;
state: keyof S;
}[]

`Protected`getStateKey

`Protected`loadState

`Protected`on

`Protected`onPopState

`Protected`onSocketError

`Protected`onSocketStateChanged

`Protected`request

`Protected`requestAsync