feat: add list() method
#82
Merged
+979
−54
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for blobs-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
the
type: feature
ascorbic
reviewed
Oct 26, 2023
README.md
Outdated
| await store.delete('my-key') | ||
| ``` | ||
|
|
||
| ### `list(options?: { cursor?: string, paginate?: boolean. prefix?: string }): Promise<{ blobs: BlobResult[] }>` |
There was a problem hiding this comment.
Good catch. Done in 3c662f2.
There was a problem hiding this comment.
It needs the option as well as the response
ascorbic
reviewed
Oct 26, 2023
README.md
Outdated
Comment on lines
287
to
288
| Optionally, you can choose to group blobs together under a common prefix and then browse them hierarchically when | ||
| listing a store. To do this, use the `/` character in your keys to group them into multiple levels. |
There was a problem hiding this comment.
I'd be explicit in saying that this is like traversing a directory structure, as we are calling it directories
There was a problem hiding this comment.
Added in 6788743. Let me know if it's clearer.
ascorbic
reviewed
Oct 26, 2023
README.md
Outdated
| To drill down into a directory and get a list of its items, you can use the directory name as the `prefix` value. | ||
|
|
||
| ```javascript | ||
| const { blobs, directories } = await store.list({ directories: true, prefix: 'mice/' }) |
There was a problem hiding this comment.
I'd add a note calling out the fact that they need to always include the trailing slash
ascorbic
approved these changes
Oct 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this pull request solving?
Adds a
list()endpoint. Check the modified README for more information about the API.Closes https://github.com/netlify/pillar-runtime/issues/753.