nv-minio-fetch

nv-minio-fetch ===================== - wrap of minio

Usage no npm install needed!

<script type="module">
  import nvMinioFetch from 'https://cdn.skypack.dev/nv-minio-fetch';
</script>

README

nv-minio-fetch

  • wrap of minio

install

  • npm install nv-minio-fetch

usage

const {MC} = require("nv-minio-fetch");

client

init

var mc = new MC();
/*
> mc
{
  protocol: 'http:',
  host: '127.0.0.1',
  port: 9000,
  accessKey: 'minioadmin',
  secretKey: 'minioadmin'
}
>
*/

add bucket

> var  p0 = mc.add("tst-bucket-0")
> var  p1 = mc.add("tst-bucket-1")
> var  p2 = mc.add("tst-bucket-2")
> var  p3 = mc.add("tst-bucket-big")
> p0
Promise { Bucket [tst-bucket-0] {} }
> p1
Promise { Bucket [tst-bucket-1] {} }
> p2
Promise { Bucket [tst-bucket-2] {} }
> p3
Promise { Bucket [tst-bucket-big] {} }
>

list buckets

> var p = mc.list()
> p
Promise {
  [
      { name: 'tst-bucket-0', creationDate: [Object] },
      { name: 'tst-bucket-1', creationDate: [Object] },
      { name: 'tst-bucket-2', creationDate: [Object] },
      { name: 'tst-bucket-big', creationDate: [Object] }
  ]
}
>

has bucket

 > var p = mc.has('tst-bucket-0')
 > p
 Promise { true }
 >

get bucket

  > var p = mc.get('tst-bucket-0')
  > p
  Promise { Bucket [tst-bucket-0] {} }
  >

del bucket

  > var p = mc.del('tst-bucket-0')
    > p
    Promise { true }
    > var p = mc.list()
    > p
    Promise {
      [
        { name: 'tst-bucket-1', creationDate: [Object] },
        { name: 'tst-bucket-2', creationDate: [Object] },
        { name: 'tst-bucket-big', creationDate: [Object] }
      ]
    }
    >

Bucket

info

    > bucket.name_
    'tst-bucket-1'

    > var p = bucket.json()
    > var p =bucket.json()
    > p
    Promise {
      {
        name: 'tst-bucket-1',
        created_at: {
          y: 2021,
          m: 8,
          d: 6,
          h: 12,
          min: 40,
          s: 11,
          ms: 474,
          ts: 1628224811.474,
          mts: 1628224811474,
          zone: '+0800',
          soffset: 28800,
          msoffset: 28800000
        },
        region: 'us-east-1',
        notification: {
          TopicConfiguration: [],
          QueueConfiguration: [],
          CloudFunctionConfiguration: []
        }
      }
    }
    >

  > var p = bucket.exists()
  > p
  Promise { true }
  >

add object

    var p = mc.get('tst-bucket-1')
    var bucket;
    p.then(r=>bucket=r)
    bucket

with file-name

    var p = bucket.add_with_file(
        "a.svg",
        "/home/dev/BROWSER/jstest/neggen-svg/1tl1t1tr1l1i1r1bl1b1br.svg",
        {"Content-Type":"image/svg+xml"}
    );

    > p
    Promise { Obj [a.svg] {} }
    >
    var p = bucket.add_with_file(
        "b.svg",
        "/home/dev/BROWSER/jstest/neggen-svg/1tl1t1tr1l1i1r1bl1b1br.svg",
        {"Content-Type":"image/svg+xml"}
    );

    > p
    Promise { Obj [b.svg] {} }
    >
    var p = bucket.add_with_file(
        "c.svg",
        "/home/dev/BROWSER/jstest/neggen-svg/1tl1t1tr1l1i1r1bl1b1br.svg",
        {"Content-Type":"image/svg+xml"}
    );
    > p
    Promise { Obj [c.svg] {} }
    >

with stream-OR-string-OR-buffer

     var stream = fs.createReadStream("/home/dev/BROWSER/jstest/neggen-svg/1tl1t1tr1l1i1r1bl1b1br.svg");
     var p = bucket.add_with_ssb(
          "d.svg",
          stream,
          {"Content-Type":"image/svg+xml"}   //optional
     );

    > p
    Promise { Obj [d.svg] {} }
    >


   /*   IF FILE is bigger, should use stream
    
    var p = mc.get('tst-bucket-big')
    var bucket;
    p.then(r=>bucket=r)
    bucket

    # ls -l /home/dev/BROWSER/jstest/bigfile/G_WIN11_X64_Q8_V2021.iso
    -rwxr--r-- 1 dev dev 5341249536 Jun 29 12:02 /home/dev/BROWSER/jstest/bigfile/G_WIN11_X64_Q8_V2021.iso

    var stream = fs.createReadStream("/home/dev/BROWSER/jstest/bigfile/G_WIN11_X64_Q8_V2021.iso")
    var p = bucket.add_with_ssb("big.iso",stream,meta={"Content-Type":"win/iso"})

   */

list object

    > var p = bucket.list()
    > p
    Promise {
      [
        {
          name: 'a.svg',
          lastModified: 2021-08-06T05:44:49.920Z,
          etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
          size: 860,
          metadata: [Object]
        },
        {
          name: 'b.svg',
          lastModified: 2021-08-06T05:45:36.481Z,
          etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
          size: 860,
          metadata: [Object]
        },
        {
          name: 'c.svg',
          lastModified: 2021-08-06T05:46:08.645Z,
          etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
          size: 860,
          metadata: [Object]
        },
        {
          name: 'd.svg',
          lastModified: 2021-08-06T05:59:26.568Z,
          etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
          size: 860,
          metadata: [Object]
        }
      ]
    }
    >

    //return stream

    var p = bucket.list_stream()
    p.then(
        s$ => {
            s$.on('data',(o)=>{console.dir(o)})
        }
    );

    > {
      name: 'a.svg',
      lastModified: 2021-08-06T05:44:49.920Z,
      etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
      size: 860,
      metadata: { 'content-type': 'image/svg+xml' }
    }
    {
      name: 'b.svg',
      lastModified: 2021-08-06T05:45:36.481Z,
      etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
      size: 860,
      metadata: { 'content-type': 'image/svg+xml' }
    }
    {
      name: 'c.svg',
      lastModified: 2021-08-06T05:46:08.645Z,
      etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
      size: 860,
      metadata: { 'content-type': 'image/svg+xml' }
    }
    {
      name: 'd.svg',
      lastModified: 2021-08-06T05:59:26.568Z,
      etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
      size: 860,
      metadata: { 'content-type': 'image/svg+xml' }
    }

get object

 > var p = bucket.get('d.svg')
 > p
 Promise { Obj [d.svg] {} }
 >

del object

        > var p = bucket.del('a.svg')
        > p
        Promise { true }
        > var p = bucket.list()
        > p
        Promise {
          [
            {
              name: 'b.svg',
              lastModified: 2021-08-06T05:45:36.481Z,
              etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
              size: 860,
              metadata: [Object]
            },
            {
              name: 'c.svg',
              lastModified: 2021-08-06T05:46:08.645Z,
              etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
              size: 860,
              metadata: [Object]
            },
            {
              name: 'd.svg',
              lastModified: 2021-08-06T05:59:26.568Z,
              etag: 'cf7f7c438b2f73790d98a4d0f558dbb2',
              size: 860,
              metadata: [Object]
            }
          ]
        }
        >

Object

    var p = mc.get('tst-bucket-1')
    var bucket;
    p.then(r=>bucket=r)
    bucket

    var p = bucket.add_with_file('x.svg',"/home/dev/BROWSER/jstest/neggen-svg/1tl1t1tr1l1i1r1bl1b1br.svg",{"Content-Type":"image/svg+xml"});

    var p = bucket.get('x.svg');
    var obj;
    p.then(r=>obj=r)

stat

> obj.name_
'x.svg'
> var p = obj.stat()
> p
    Promise {
      {
        size: 860,
        metaData: { 'content-type': 'image/svg+xml' },
        lastModified: 2021-08-06T06:54:11.000Z,
        etag: 'cf7f7c438b2f73790d98a4d0f558dbb2'
      }
    }
    >

presigned-url

    > var p = obj.creat_tmp_get_url(1000*3600*24)
    > p
    Promise {
      'http://127.0.0.1:9000/tst-bucket-1/x.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20210806%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210806T071705Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=632d87fabfc8aea9cd0b7dc2d32f9aedf910e7b795c35196822b755fea009cc8'
    }
    >
    > var p = obj.creat_tmp_put_url(1000*3600*24)
    > p
    Promise {
      'http://127.0.0.1:9000/tst-bucket-1/x.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20210806%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210806T071721Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=06b1e0e48bcc5b37dc07de02a3910ad94e9a721b5f9ce90b86d0638fbf655412'
    }
    >

bin-data

data(Buffer)

    > var p = obj.data()
    > p
    Promise {
      <Buffer 3c 3f 78 6d 6c 20 76 65 72 73 69 6f 6e 3d 22 31 2e 30 22 20 65 6e 63 6f 64 69 6e 67 3d 22 75 74 66 2d 38 22 3f 3e 3c 73 76 67 20 76 65 72 73 69 6f 6e ... 810 more bytes>
    }
    >
    > var p = obj.data(0,4)
    > p
    Promise { <Buffer 3c 3f 78 6d> }
    >

stream

    /*if file is very-big(>1G), should use this */

        > var p = obj.stream(0,4)

        > p.then(
        ...     s$=> {
        .....       s$.on('data',(r)=>console.log(r))
        .....   }
        ... )
        Promise { <pending> }
        > <Buffer 3c 3f 78 6d>

        >

download

tofile

  var p = obj.download_to_small_file('tmp.svg')
  /*
    root@dev:/home/cu-proj/chengqu-zhiku/back/TEST# ls -l
    total 36
    -rw-r--r-- 1 root root 30487 Jul 29 07:57 hr-random-insert.js
    -rw-r--r-- 1 root root   860 Aug  6 07:28 tmp.svg
  */

   /*if file is very-big(>1G), should use this or stream */

   var p = obj.download_to_file('part0.part',0,4);
   > p
   Promise { true }
   >
   /*
     /home/cu-proj/chengqu-zhiku/back/TEST# ls -l
     total 36
    -rw-r--r-- 1 root root 30487 Jul 29 07:57 hr-random-insert.js
    -rw-r--r-- 1 root root     4 Aug  6 09:32 part0.part

   */

to-write-stream

  /*bridge to a write-stream*/
 
  download_to_write_stream(ws$,offset=-Infinity,length=Infinity,getOpts={})

renew

  /*if file is very-big(>1G), should use read-stream */
  obj.upload_from_stream(src,meta={})


  obj.upload_from_file(src_file,meta={})
  obj.upload_from_buffer(src,meta={})
  obj.upload_from_string(src,meta={})

METHODS

client

  mc.add(bucket_name,opts={})   
  mc.has(bucket_name)   
  mc.list()           
  mc.get(bucket_name)                          
  mc.del(bucket_name)

bucket

 bucket.get_created_at()                   bucket.get_notification()
 bucket.get_policy()                       bucket.get_region()
 bucket.json()
 bucket.mc_                              bucket.name_
 bucket.exists()


 bucket.add_with_file(obj_name,src_file,meta={})
 bucket.add_with_ssb(obj_name,src,meta={})
 
 bucket.set_if_exist_else_add_with_file  
 bucket.set_if_exist_else_add_with_ssb
 bucket.set_with_file                    
 bucket.set_with_ssb


 bucket.list()                 //return a list of obj-description           
 bucket.list_stream()          //return a obj-description stream

 bucket.get(obj_name,tz='+0800')

object

  obj.name_;
  obj.bucket_;
  obj.stat();
  obj.exists();
  obj.eq(o);            //same as o

 
  obj.creat_tmp_get_url(expire=1000*3600*24);
  obj.creat_tmp_put_url(expire=1000*3600*24);


  obj.data(offset=-Infinity,length=Infinity,getOpts={});
  obj.stream(offset=-Infinity,length=Infinity,getOpts={}); 

  
  obj.download_to_file(dst_fn,offset=-Infinity,length=Infinity,getOpts={})
  obj.download_to_write_stream(ws$,offset=-Infinity,length=Infinity,getOpts={})
  obj.download_to_small_file(dst_fn) 


  obj.upload_from_stream(src,meta={})
  obj.upload_from_file(src_file,meta={})
  obj.upload_from_buffer(src,meta={})
  obj.upload_from_string(src,meta={})

  obj.erase()    //remove self

LICENSE

  • ISC