Skip to content

Commit

Permalink
added installtion instructions and todo
Browse files Browse the repository at this point in the history
  • Loading branch information
ap-atul committed Aug 12, 2022
1 parent d43e3d0 commit 2ab7aff
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
12 changes: 6 additions & 6 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"typescript.preferences.importModuleSpecifier": "relative",
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"typescript.preferences.importModuleSpecifier": "relative",
"editor.formatOnSave": true
}
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
This plugin allows generating a signed url for a file link/id. Useful when
using with AWS S3 sign urls for private objects.

## Installation

```
npm i hapi-signed-url
```

## Basic Usage

- Import the plugin
Expand Down Expand Up @@ -113,3 +119,20 @@ server.route({

- It will work with single objects and arrays. `pathToSource` is optional field,
use when nested objects are to be updated.

- Improvements todo
- Change the options structure to following, which will allow using multiple paths

```js
const options = {
sources: [
{
lenses: [nameLens],
},
{
lenses: [fileLens],
path: docLens,
},
],
};
```

0 comments on commit 2ab7aff

Please sign in to comment.