feat: Expose some of the low level single node client calls

Author: obany

dist/iota.browser.js

@@ -22,6 +22,10 @@ Client for API communication.
 - [addressEd25519](clients_singlenodeclient.singlenodeclient.md#addressed25519)
 - [addressEd25519Outputs](clients_singlenodeclient.singlenodeclient.md#addressed25519outputs)
 - [addressOutputs](clients_singlenodeclient.singlenodeclient.md#addressoutputs)
+- [combineQueryParams](clients_singlenodeclient.singlenodeclient.md#combinequeryparams)
+- [fetchBinary](clients_singlenodeclient.singlenodeclient.md#fetchbinary)
+- [fetchJson](clients_singlenodeclient.singlenodeclient.md#fetchjson)
+- [fetchStatus](clients_singlenodeclient.singlenodeclient.md#fetchstatus)
 - [health](clients_singlenodeclient.singlenodeclient.md#health)
 - [info](clients_singlenodeclient.singlenodeclient.md#info)
 - [message](clients_singlenodeclient.singlenodeclient.md#message)
@@ -146,6 +150,95 @@ Implementation of: [IClient](../interfaces/models_iclient.iclient.md)
 
 ___
 
+### combineQueryParams
+
+▸ **combineQueryParams**(`queryParams`: *string*[]): *string*
+
+Combine the query params.
+
+#### Parameters:
+
+Name | Type | Description |
+:------ | :------ | :------ |
+`queryParams` | *string*[] | The quer params to combine.   |
+
+**Returns:** *string*
+
+The combined query params.
+
+___
+
+### fetchBinary
+
+▸ **fetchBinary**<T\>(`method`: *get* \| *post*, `route`: *string*, `requestData?`: *Uint8Array*): *Promise*<Uint8Array \| T\>
+
+Perform a request for binary data.
+
+#### Type parameters:
+
+Name |
+:------ |
+`T` |
+
+#### Parameters:
+
+Name | Type | Description |
+:------ | :------ | :------ |
+`method` | *get* \| *post* | The http method.   |
+`route` | *string* | The route of the request.   |
+`requestData?` | *Uint8Array* | Request to send to the endpoint.   |
+
+**Returns:** *Promise*<Uint8Array \| T\>
+
+The response.
+
+___
+
+### fetchJson
+
+▸ **fetchJson**<T, U\>(`method`: *get* \| *post* \| *delete*, `route`: *string*, `requestData?`: T): *Promise*<U\>
+
+Perform a request in json format.
+
+#### Type parameters:
+
+Name |
+:------ |
+`T` |
+`U` |
+
+#### Parameters:
+
+Name | Type | Description |
+:------ | :------ | :------ |
+`method` | *get* \| *post* \| *delete* | The http method.   |
+`route` | *string* | The route of the request.   |
+`requestData?` | T | Request to send to the endpoint.   |
+
+**Returns:** *Promise*<U\>
+
+The response.
+
+___
+
+### fetchStatus
+
+▸ **fetchStatus**(`route`: *string*): *Promise*<number\>
+
+Perform a request and just return the status.
+
+#### Parameters:
+
+Name | Type | Description |
+:------ | :------ | :------ |
+`route` | *string* | The route of the request.   |
+
+**Returns:** *Promise*<number\>
+
+The response.
+
+___
+
 ### health
 
 ▸ **health**(): *Promise*<boolean\>

dist/iota.js

@@ -450,9 +450,8 @@ export class SingleNodeClient implements IClient {
      * Perform a request and just return the status.
      * @param route The route of the request.
      * @returns The response.
-     * @internal
      */
-    private async fetchStatus(route: string): Promise<number> {
+    public async fetchStatus(route: string): Promise<number> {
         const response = await this.fetchWithTimeout("get", route);
 
         return response.status;
@@ -464,9 +463,8 @@ export class SingleNodeClient implements IClient {
      * @param route The route of the request.
      * @param requestData Request to send to the endpoint.
      * @returns The response.
-     * @internal
      */
-    private async fetchJson<T, U>(method: "get" | "post" | "delete", route: string, requestData?: T): Promise<U> {
+    public async fetchJson<T, U>(method: "get" | "post" | "delete", route: string, requestData?: T): Promise<U> {
         const response = await this.fetchWithTimeout(
             method,
             `${this._basePath}${route}`,
@@ -534,9 +532,8 @@ export class SingleNodeClient implements IClient {
      * @param route The route of the request.
      * @param requestData Request to send to the endpoint.
      * @returns The response.
-     * @internal
      */
-    private async fetchBinary<T>(
+    public async fetchBinary<T>(
         method: "get" | "post",
         route: string,
         requestData?: Uint8Array): Promise<Uint8Array | T> {
@@ -580,7 +577,7 @@ export class SingleNodeClient implements IClient {
      * @returns The response.
      * @internal
      */
-    private async fetchWithTimeout(
+    public async fetchWithTimeout(
         method: "get" | "post" | "delete",
         route: string,
         headers?: { [id: string]: string },
@@ -644,7 +641,7 @@ export class SingleNodeClient implements IClient {
      * @param queryParams The quer params to combine.
      * @returns The combined query params.
      */
-    private combineQueryParams(queryParams: string[]): string {
+    public combineQueryParams(queryParams: string[]): string {
         return queryParams.length > 0 ? `?${queryParams.join("&")}` : "";
     }
 

docs/classes/clients_singlenodeclient.singlenodeclient.md

@@ -168,10 +168,32 @@ export declare class SingleNodeClient implements IClient {
      * @returns The details for the created peer.
      */
     peer(peerId: string): Promise<IPeer>;
+    /**
+     * Perform a request and just return the status.
+     * @param route The route of the request.
+     * @returns The response.
+     */
+    fetchStatus(route: string): Promise<number>;
+    /**
+     * Perform a request in json format.
+     * @param method The http method.
+     * @param route The route of the request.
+     * @param requestData Request to send to the endpoint.
+     * @returns The response.
+     */
+    fetchJson<T, U>(method: "get" | "post" | "delete", route: string, requestData?: T): Promise<U>;
+    /**
+     * Perform a request for binary data.
+     * @param method The http method.
+     * @param route The route of the request.
+     * @param requestData Request to send to the endpoint.
+     * @returns The response.
+     */
+    fetchBinary<T>(method: "get" | "post", route: string, requestData?: Uint8Array): Promise<Uint8Array | T>;
     /**
      * Combine the query params.
      * @param queryParams The quer params to combine.
      * @returns The combined query params.
      */
-    private combineQueryParams;
+    combineQueryParams(queryParams: string[]): string;
 }