file-box v1.4.15

FILEBOX

Pack a file in a Box for easy transport between servers with the least payload, no mater than where it is.(local path, remote url, or cloud storage)

WIP

WORKING IN PROGRESS ...

PLEASE COME BACK AFTER 4 WEEKS ...

FEATURES

1. Present A File by Abstracting It's Meta Information that supports Reading & toJSON() API.
2. Follow DOM File/BLOB Interface
3. Present a file that could be: Local, Remote, Stream
4. Lazy load
5. Serializable
6. Can be Transfered from server to server, server to browser.

SCHEMAS

Url

Node.js Documentation > URL Strings and URL Objects

┌─────────────────────────────────────────────────────────────────────────────────────────────┐
│                                            href                                             │
├──────────┬──┬─────────────────────┬─────────────────────┬───────────────────────────┬───────┤
│ protocol │  │        auth         │        host         │           path            │ hash  │
│          │  │                     ├──────────────┬──────┼──────────┬────────────────┤       │
│          │  │                     │   hostname   │ port │ pathname │     search     │       │
│          │  │                     │              │      │          ├─┬──────────────┤       │
│          │  │                     │              │      │          │ │    query     │       │
"  https:   //    user   :   pass   @ sub.host.com : 8080   /p/a/t/h  ?  query=string   #hash "
│          │  │          │          │   hostname   │ port │          │                │       │
│          │  │          │          ├──────────────┴──────┤          │                │       │
│ protocol │  │ username │ password │        host         │          │                │       │
├──────────┴──┼──────────┴──────────┼─────────────────────┤          │                │       │
│   origin    │                     │       origin        │ pathname │     search     │ hash  │
├─────────────┴─────────────────────┴─────────────────────┴──────────┴────────────────┴───────┤
│                                            href                                             │
└─────────────────────────────────────────────────────────────────────────────────────────────┘

Path

Node.js Documentation > path.parse(path)

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
"  /    home/user/dir / file  .txt "
└──────┴──────────────┴──────┴─────┘

SEE ALSO

• File API - W3C Working Draft, 26 October 2017
• MIME Sniffing - Living Standard — Last Updated 20 April 2018
• Using files from web applications
• Web technology for developers > Web APIs > File
• Web technology for developers > Web APIs > Blob
• Web technology for developers > Web APIs > FileReader

THANKS

This module is inspired by https://github.com/gulpjs/vinyl and https://github.com/DefinitelyTyped/DefinitelyTyped/pull/12368 when I need a virtual File module for my Chatie project.

AUTHOR

Huan LI \zixia@zixia.net\

COPYRIGHT & LICENSE

• Code & Docs © 2016-2018 Huan LI \zixia@zixia.net\
• Code released under the Apache-2.0 License
• Docs released under Creative Commons