Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into refactor-client
Browse files Browse the repository at this point in the history
  • Loading branch information
trim21 committed Apr 30, 2023
2 parents d7fe996 + d6d82c0 commit 4f41459
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
24 changes: 24 additions & 0 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ __Parameters__
| `transport` | _string_ | Set this value to pass in a custom transport. (Optional) |
| `partSize` | _number_ | Set this value to override default part size of 64MB for multipart uploads. (Optional) |
| `pathStyle` | _bool_ | Set this value to override default access behavior (path) for non AWS endpoints. Default is true. (Optional) |
| `transportAgent` | [Agent](https://nodejs.org/api/http.html#class-httpagent) | Set this value to provide a custom HTTP(s) agent to handle timeouts, TLS handling, and low-level socket configurations. (Optional) |

__Example__

Expand Down Expand Up @@ -120,6 +121,29 @@ var s3Client = new Minio.Client({
})
```

## Create client with custom HTTPS Agent

```js
var Minio = require('minio')
var fs = require('fs')
var https = require('https')

var s3Client = new Minio.Client({
endPoint: 'play.min.io',
port: 9000,
useSSL: true,
accessKey: 'Q3AM3UQ867SPQQA43P2F',
secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
transportAgent: new https.Agent({
timeout: 10000,
ca: fs.readFileSync("path/to/ca.cert"),
cert: fs.readFileSync("path/to/public.cert"),
key: fs.readFileSync("path/to/secret.key"),
keepAlive: false,
})
})
```

## 2. Bucket operations
<a name="makeBucket"></a>

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "minio",
"version": "7.0.34",
"version": "7.1.1",
"description": "S3 Compatible Cloud Storage client",
"source": "./src/minio.ts",
"main": "./dist/cjs/minio.js",
Expand Down

0 comments on commit 4f41459

Please sign in to comment.