@fizz.js/node-file-client

This is a file-client library for express.

install

add dependencies into package.json and run yarn install

configure

please put file config into config/${env}.json

``[json]
{
"file": {
"base": {
"directory": "./tmp/"
},
"oss": {
"region": "",
"accessKeyId": "",
"accessKeySecret": "",
"bucket": ""
}
}
}
`

or put ALI_OSS_ACCESS_KEY_ID, ALI_OSS_ACCESS_KEY_SECRET, ALI_OSS_REGION, ALI_OSS_BUCKET into your .env file.

`[env]
ALI_OSS_ACCESS_KEY_ID="XXXXXXXXXX"
ALI_OSS_ACCESS_KEY_SECRET="XXXXXXXXXX"
ALI_OSS_REGION="XXXXXXXXXX"
ALI_OSS_BUCKET="XXXXXXXXXX"
`

test

`[bash]
yarn test
`

coverage

`[bash]
yarn cover
`

build

`[bash]
yarn build
`

docs

`[bash]
yarn docs
``