xjs-node 3.0.0-alpha.3 → 3.0.0-alpha.4

package/build/func/u-file.d.ts

@@ -1,6 +1,10 @@
 import * as fs from "fs";
 import { MaybeArray } from "xjs-common";
 export declare namespace UFile {
+    /**
+     * make directory. this raise no error if the directory to be made exists.
+     * this returns boolean whether mkdir was executed or not.
+     */
     function mkdir(p: MaybeArray<string>): boolean;
     function write(p: MaybeArray<string>, c: string): Promise<void>;
     /**

package/build/func/u-file.js

@@ -41,6 +41,10 @@ const u_1 = require("./u");
 const s_errCode = 1040;
 var UFile;
 (function (UFile) {
+    /**
+     * make directory. this raise no error if the directory to be made exists.
+     * this returns boolean whether mkdir was executed or not.
+     */
     function mkdir(p) {
         const dirPath = (0, u_1.joinPath)(p);
         const e = fs.existsSync(dirPath);

package/build/obj/http-client.d.ts

@@ -107,4 +107,29 @@ export interface HttpClient {
         responseType: "buffer";
     }): Promise<HttpResponse<Buffer>>;
     post(url: string, payload: any, op?: RequestOption & ClientOption): Promise<HttpResponse<string>>;
+    /**
+     * request PUT to the url with new context.
+     * @param url target url. (currently https only)
+     * @param payload request payload. if this is a Stream, pipe will be used, otherwise if an object, this is treated as json.
+     * @param op.headers http headers.
+     * @param op.mode {@link s_clientMode} that is imitated. default is random between chrome or firefox.
+     * @param op.proxy proxy configuration.
+     * @param op.ignoreQuery {@link RequestOption.ignoreQuery}
+     * @param op.timeout {@link RequestOption.timeout}
+     * @param op.responseType {@link RequestOption.responseType}
+     * @returns http response. {@link HttpResponse}
+     */
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & ClientOption & {
+        responseType: "string";
+    }): Promise<HttpResponse<string>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & ClientOption & {
+        responseType: "buffer";
+    }): Promise<HttpResponse<Buffer>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & ClientOption): Promise<HttpResponse<string>>;
 }

package/build/prcs/http-resolver-context.d.ts

@@ -43,9 +43,22 @@ export declare class HttpResolverContext implements HttpClient {
         responseType: "buffer";
     }): Promise<HttpResponse<Buffer>>;
     post(url: string, payload: any, op?: RequestOption): Promise<HttpResponse<string>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & {
+        responseType: "string";
+    }): Promise<HttpResponse<string>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & {
+        responseType: "buffer";
+    }): Promise<HttpResponse<Buffer>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    }): Promise<HttpResponse<string>>;
     private createProxyAgent;
     private getIn;
-    private postIn;
+    private postputIn;
     private reqHttps;
     private processResponse;
     private resolveDownloadPath;

package/build/prcs/http-resolver-context.js

@@ -123,7 +123,14 @@ class HttpResolverContext {
         const proxyAgent = this._proxyConfig && await this.createProxyAgent(u);
         const rc = { redirectCount: 0, proxyAgent };
         Object.assign(rc, op);
-        return await this._als.run(rc, this.postIn, u, payload).finally(() => proxyAgent?.destroy());
+        return await this._als.run(rc, this.postputIn, u, xjs_common_1.HttpMethod.Post, payload).finally(() => proxyAgent?.destroy());
+    }
+    async put(url, payload, op) {
+        const u = new url_1.URL(url);
+        const proxyAgent = this._proxyConfig && await this.createProxyAgent(u);
+        const rc = { redirectCount: 0, proxyAgent };
+        Object.assign(rc, op);
+        return await this._als.run(rc, this.postputIn, u, xjs_common_1.HttpMethod.Put, payload).finally(() => proxyAgent?.destroy());
     }
     createProxyAgent(u) {
         const conf = this._proxyConfig;
@@ -158,10 +165,10 @@ class HttpResolverContext {
         params.headers = xjs_common_1.UHttp.normalizeHeaders(rc.headers);
         return await this.reqHttps(u, params);
     };
-    postIn = async (u, payload) => {
+    postputIn = async (u, method, payload) => {
         const params = {};
         const rc = this._als.getStore();
-        params.method = xjs_common_1.HttpMethod.Post;
+        params.method = method;
         params.headers = xjs_common_1.UHttp.normalizeHeaders(rc.headers);
         let p = payload;
         if (p instanceof stream_1.Stream) {

package/build/prcs/http-resolver.d.ts

@@ -43,4 +43,17 @@ export declare class HttpResolver implements HttpClient {
         responseType: "buffer";
     }): Promise<HttpResponse<Buffer>>;
     post(url: string, payload: any, op?: RequestOption & ClientOption): Promise<HttpResponse<string>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & ClientOption & {
+        responseType: "string";
+    }): Promise<HttpResponse<string>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & ClientOption & {
+        responseType: "buffer";
+    }): Promise<HttpResponse<Buffer>>;
+    put(url: string, payload: any, op?: RequestOption & {
+        downloadPath: never;
+    } & ClientOption): Promise<HttpResponse<string>>;
 }

package/build/prcs/http-resolver.js

@@ -48,5 +48,8 @@ class HttpResolver {
     async post(url, payload, op) {
         return await this.newContext(op).post(url, payload, op);
     }
+    async put(url, payload, op) {
+        return await this.newContext(op).put(url, payload, op);
+    }
 }
 exports.HttpResolver = HttpResolver;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xjs-node",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.4",
   "description": "library modules for nodejs + typescript that bundled general-purpose implementations.",
   "repository": {
     "type": "git",