samjs-files
Adds a model and interface for file/folder interaction.
Client: samjs-files-client
Getting Started
npm install --save samjs-files
Usage
// server-sidesamjspluginsoptions
// client-sidesamjsplugins model1 = samjsmodel1 // filename can be omitted when model only has one file model1 model1 model2 = samjsmodel2model2
model props
name | type | default | description |
---|---|---|---|
cache | Boolean | false |
set false when files are large, many or seldom used. Will load the files in memory and activate a fs.watch |
options | Object | {encoding: null} |
will be passed to fs.readFile |
access | Object | {} |
use to control access, with, e.g. samjs-files-auth |
model hooks
each hook has to return its arguments.
name | arguments | description |
---|---|---|
beforeGet | {file, client} |
will be called before each get |
afterGet | data |
will be called after each get |
beforeSet | {data, file, client} |
will be called before each set |
afterSet | file |
will be called after each set |
before_Set | {data, file} |
will be called before each server-side _set |
after_Set | file |
will be called after each server-side _set |
beforeCreate | model |
will be called before model creation |
afterCreate | model |
will be called after model creation |
example:
samjspluginsoptions
plugins
plugins are activated on model level
samjspluginsoptions