Class protowrap

Hierarchy

protowrap

Index

Constructors

constructor

new protowrap(): protowrap
Returns protowrap

Properties

`Static` defaultprotocol

defaultprotocol: clientType = "pipe"

`Static` grpc_server_options

grpc_server_options: ChannelOptions = ...

`Static` openiap_proto

openiap_proto: ProtobufTypeDefinition | ServiceClientConstructor | GrpcObject

`Static` protoRoot

protoRoot: any

Methods

`Static` ClientCleanup

ClientCleanup(client: client, onClientDisconnected: any, error: string | Error): void
Parameters
- client: client
- onClientDisconnected: any
- error: string | Error
Returns void
- Defined in src/protowrap.ts:614

`Static` CommandToProto

CommandToProto(command: string): string
Parameters
- command: string
Returns string
- Defined in src/protowrap.ts:101

`Static` CreateStream

CreateStream(client: client, stream: any, payload: any): Promise<unknown>
Parameters
- client: client
- stream: any
- payload: any
Returns Promise<unknown>
- Defined in src/protowrap.ts:200

`Static` DownloadFile

DownloadFile(client: client, id: string, collectionname: string, filename: string, folder: string, highWaterMark: number): Promise<DownloadResponse>
Parameters
- client: client
- id: string
- collectionname: string
- filename: string
- folder: string
- highWaterMark: number
Returns Promise<DownloadResponse>
- Defined in src/protowrap.ts:213

`Static` IsPendingReply

IsPendingReply(client: client, payload: Envelope): any
Parameters
- client: client
- payload: Envelope
Returns any
- Defined in src/protowrap.ts:385

`Static` RPC

RPC(client: client, payload: any): Promise<Envelope>
Parameters
- client: client
- payload: any
Returns Promise<Envelope>
- Defined in src/protowrap.ts:171

`Static` ReceiveFileContent

ReceiveFileContent(client: client, rid: string, filename: string, highWaterMark: number): Promise<unknown>
Parameters
- client: client
- rid: string
- filename: string
- highWaterMark: number
Returns Promise<unknown>
- Defined in src/protowrap.ts:353

`Static` SetStream

SetStream(client: client, stream: any, rid: string): any
Parameters
- client: client
- stream: any
- rid: string
Returns any
- Defined in src/protowrap.ts:196

`Static` UploadFile

UploadFile(client: client, filename: string, metadata: object, jwt: string): Promise<UploadResponse>
Parameters
- client: client
- filename: string
- metadata: object
- jwt: string
Returns Promise<UploadResponse>
- Defined in src/protowrap.ts:329

`Static` _RPC

_RPC(client: client, payload: any): [string, Promise<any>]
Parameters
- client: client
- payload: any
Returns [string, Promise<any>]
- Defined in src/protowrap.ts:175

`Static` connect

connect(apiurl: string, clientConstructor?: (new () => iclient)): client
Parameters
- apiurl: string
- clientConstructor: (new () => iclient) = client
  - - new (): iclient
    - Returns iclient
Returns client
- Defined in src/protowrap.ts:649

`Static` get

get(url: any): Promise<unknown>
Parameters
- url: any
Returns Promise<unknown>
- Defined in src/protowrap.ts:460

`Static` getChecksum

getChecksum(buffer: any): string
Parameters
- buffer: any
Returns string
- Defined in src/protowrap.ts:1121

`Static` getFileChecksum

getFileChecksum(filePath: any): Promise<string>
Parameters
- filePath: any
Returns Promise<string>
- Defined in src/protowrap.ts:1105

`Static` init

init(): Promise<void>
Returns Promise<void>
- Defined in src/protowrap.ts:68

`Static` pack

pack(command: any, payload: any): {
type_url: string;
value: any;
}
Parameters
- command: any
- payload: any
Returns {
type_url: string;
value: any;
}
- type_url: string
- value: any
- Defined in src/protowrap.ts:126

`Static` post

post(jwt: any, agent: any, url: any, body: any): Promise<unknown>
Parameters
- jwt: any
- agent: any
- url: any
- body: any
Returns Promise<unknown>
- Defined in src/protowrap.ts:480

`Static` sendFileContent

sendFileContent(client: client, rid: any, filename: any, highWaterMark: any): Promise<unknown>
Parameters
- client: client
- rid: any
- filename: any
- highWaterMark: any
Returns Promise<unknown>
- Defined in src/protowrap.ts:275

`Static` sendMesssag

sendMesssag(client: client, payload: any, id: string, dumpmsg: boolean): number
Parameters
- client: client
- payload: any
- id: string
- dumpmsg: boolean
Returns number
- Defined in src/protowrap.ts:528

`Static` serve

serve(protocol: clientType, onClientConnected: any, port: any, path: any, wss: any, app: any, http: any, clientConstructor?: (new () => iclient)): {
    app: any;
    client: any;
    connected: boolean;
    connecting: boolean;
    http: any;
    id: string;
    pending: {};
    port: any;
    protocol: clientType;
    ws: any;
    wss: any;
}
Parameters
- protocol: clientType
- onClientConnected: any
- port: any
- path: any
- wss: any
- app: any
- http: any
- clientConstructor: (new () => iclient) = client
  - - new (): iclient
    - Returns iclient
Returns {
    app: any;
    client: any;
    connected: boolean;
    connecting: boolean;
    http: any;
    id: string;
    pending: {};
    port: any;
    protocol: clientType;
    ws: any;
    wss: any;
}
- app: any
- client: any
- connected: boolean
- connecting: boolean
- http: any
- id: string
- pending: {}
- port: any
- protocol: clientType
- ws: any
- wss: any
- Defined in src/protowrap.ts:854

`Static` unpack

unpack(message: any): any[]
Parameters
- message: any
Returns any[]
- Defined in src/protowrap.ts:137

Class protowrap

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns protowrap

Properties

Static defaultprotocol

Static grpc_server_options

Static openiap_proto

Static protoRoot

Methods

Static ClientCleanup

Parameters

client: client

onClientDisconnected: any

error: string | Error

Returns void

Static CommandToProto

Parameters

command: string

Returns string

Static CreateStream

Parameters

client: client

stream: any

payload: any

Returns Promise<unknown>

Static DownloadFile

Parameters

client: client

id: string

collectionname: string

filename: string

folder: string

highWaterMark: number

Returns Promise<DownloadResponse>

Static IsPendingReply

Parameters

client: client

payload: Envelope

Returns any

Static RPC

Parameters

client: client

payload: any

Returns Promise<Envelope>

Static ReceiveFileContent

Parameters

client: client

rid: string

filename: string

highWaterMark: number

Returns Promise<unknown>

Static SetStream

Parameters

client: client

stream: any

rid: string

Returns any

Static UploadFile

Parameters

client: client

filename: string

metadata: object

jwt: string

Returns Promise<UploadResponse>

Static _RPC

Parameters

client: client

payload: any

Returns [string, Promise<any>]

Static connect

Parameters

apiurl: string

clientConstructor: (new () => iclient) = client

Returns iclient

`Static` defaultprotocol

`Static` grpc_server_options

`Static` openiap_proto

`Static` protoRoot

`Static` ClientCleanup

`Static` CommandToProto

`Static` CreateStream

`Static` DownloadFile

`Static` IsPendingReply

`Static` RPC

`Static` ReceiveFileContent

`Static` SetStream

`Static` UploadFile

`Static` _RPC

`Static` connect

`Static` get

`Static` getChecksum

`Static` getFileChecksum

`Static` init

`Static` pack

Returns {
type_url: string;
value: any;
}

`Static` post

`Static` sendFileContent

`Static` sendMesssag

`Static` serve

Returns {
app: any;
client: any;
connected: boolean;
connecting: boolean;
http: any;
id: string;
pending: {};
port: any;
protocol: clientType;
ws: any;
wss: any;
}

`Static` unpack