Giter VIP home page Giter VIP logo

minio-js's Introduction

MinIO JavaScript Library for Amazon S3 Compatible Cloud Storage Slack

NPM

The MinIO JavaScript Client SDK provides high level APIs to access any Amazon S3 compatible object storage server.

This guide will show you how to install the client SDK and execute an example JavaScript program. For a complete list of APIs and examples, please take a look at the JavaScript Client API Reference documentation.

This document presumes you have a working Node.js development environment, LTS versions v16, v18 or v20.

Download from NPM

npm install --save minio

Download from Source

git clone https://github.com/minio/minio-js
cd minio-js
npm install
npm run build
npm install -g

Using with TypeScript

minio>7.1.0 is shipped with builtin type definition, @types/minio is no longer needed.

Initialize MinIO Client

The following parameters are needed to connect to a MinIO object storage server:

Parameter Description
endPoint Hostname of the object storage service.
port TCP/IP port number. Optional, defaults to 80 for HTTP and 443 for HTTPs.
accessKey Access key (user ID) of an account in the S3 service.
secretKey Secret key (password) of an account in the S3 service.
useSSL Optional, set to 'true' to enable secure (HTTPS) access.
import * as Minio from 'minio'

const minioClient = new Minio.Client({
  endPoint: 'play.min.io',
  port: 9000,
  useSSL: true,
  accessKey: 'Q3AM3UQ867SPQQA43P2F',
  secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
})

Quick Start Example - File Uploader

This example connects to an object storage server, creates a bucket, and uploads a file to the bucket. It uses the MinIO play server, a public MinIO cluster located at https://play.min.io.

The play server runs the latest stable version of MinIO and may be used for testing and development. The access credentials shown in this example are open to the public. All data uploaded to play should be considered public and non-protected.

file-uploader.mjs

import * as Minio from 'minio'

// Instantiate the MinIO client with the object store service
// endpoint and an authorized user's credentials
// play.min.io is the MinIO public test cluster
const minioClient = new Minio.Client({
  endPoint: 'play.min.io',
  port: 9000,
  useSSL: true,
  accessKey: 'Q3AM3UQ867SPQQA43P2F',
  secretKey: 'zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG',
})

// File to upload
const sourceFile = '/tmp/test-file.txt'

// Destination bucket
const bucket = 'js-test-bucket'

// Destination object name
const destinationObject = 'my-test-file.txt'

// Check if the bucket exists
// If it doesn't, create it
const exists = await minioClient.bucketExists(bucket)
if (exists) {
  console.log('Bucket ' + bucket + ' exists.')
} else {
  await minioClient.makeBucket(bucket, 'us-east-1')
  console.log('Bucket ' + bucket + ' created in "us-east-1".')
}

// Set the object metadata
var metaData = {
  'Content-Type': 'text/plain',
  'X-Amz-Meta-Testing': 1234,
  example: 5678,
}

// Upload the file with fPutObject
// If an object with the same name exists,
// it is updated with new data
await minioClient.fPutObject(bucket, destinationObject, sourceFile, metaData)
console.log('File ' + sourceFile + ' uploaded as object ' + destinationObject + ' in bucket ' + bucket)

Run the File Uploader

node file-uploader.mjs
Bucket js-test-bucket created successfully in "us-east-1".
File /tmp/test-file.txt uploaded successfully as my-test-file.txt to bucket js-test-bucket

Verify the object was created with mc:

mc ls play/js-test-bucket
[2023-11-10 17:52:20 UTC]  20KiB STANDARD my-test-file.txt

API Reference

The complete API Reference is available here:

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

Bucket Policy Operations

Examples

Bucket Operations

File Object Operations

Object Operations

Presigned Operations

Bucket Notification Operations

Bucket Policy Operations

Custom Settings

Explore Further

Contribute

GitHub Workflow Status

minio-js's People

Contributors

harshavardhana avatar krishnasrinivas avatar minio-trusted avatar prakashsvmx avatar trim21 avatar kannappanr avatar dependabot[bot] avatar brendanashworth avatar koolhead17 avatar vadmeste avatar kaankabalak avatar ebozduman avatar deekoder avatar aldy505 avatar garimakapoor avatar joaofranciscosantos avatar loremaps avatar kanagarajkm avatar nitisht avatar poornas avatar dcharbonnier avatar fluxxu avatar djwfyi avatar barinbritva avatar colhodm avatar feorlen avatar bexsoft avatar jefvel avatar nomagick avatar will3942 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.