fix: deprecated directory. prefix should be used instead #1370
Conversation
product-auto-label
bot
added
the
api: storage
google-cla
bot
added
the
cla: yes
Codecov Report
@@ Coverage Diff @@
## master #1370 +/- ##
=======================================
Coverage 99.09% 99.09%
=======================================
Files 14 14
Lines 12108 12109 +1
Branches 524 524
=======================================
+ Hits 11999 12000 +1
Misses 109 109
Continue to review full report at Codecov.
|
src/bucket.ts
Outdated
| * @property {string} [directory] Filter results based on a directory name, or | ||
| * more technically, a "prefix". | ||
| * @deprecated @property {string} [directory] Filter results based on a directory name, or | ||
| * more technically, a "prefix". Deprecated. Use prefix instead. |
There was a problem hiding this comment.
Please add a note that directory uses delimiter='/' in case folks get confused.
Recommend including an example of using prefix and delimiter below to reference.
There was a problem hiding this comment.
Hi Frank, this example includes prefix and delimiter. Are you looking for something different?
src/bucket.ts
Outdated
| @@ -113,7 +113,7 @@ export interface EnableLoggingOptions { | |||
| export interface GetFilesOptions { | |||
| autoPaginate?: boolean; | |||
| delimiter?: string; | |||
| directory?: string; | |||
| directory?: string; //deprecated | |||
There was a problem hiding this comment.
Is this the recommended approach to declare deprecation in an interface? I don't see another example in the project that deprecates this way, and want to confirm.
…affeeullah/deprecateDirectory
Fixes #1343 🦕