New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@azure/storage-file-share

Package Overview
Dependencies
Maintainers
3
Versions
387
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@azure/storage-file-share - npm Package Compare versions

Comparing version 12.0.0-dev.20191122.1 to 12.0.0-dev.20191123.1

1

ChangeLog.md

@@ -8,2 +8,3 @@ # Changelog

- Updated to use OpenTelemetry 0.2 via `@azure/core-tracing`
- Bug Fix - Convert empty prefixes (`""`) to `undefined` when passed as options to the `listFiles` or `listShares` methods to avoid sending an invalid request to the service. Fixes bug [5817](https://github.com/Azure/azure-sdk-for-js/issues/5817).

@@ -10,0 +11,0 @@ ## 2019.11 12.0.0-preview.6

324

dist-esm/src/ShareDirectoryClient.js

@@ -181,3 +181,4 @@ // Copyright (c) Microsoft Corporation. All rights reserved.

*
* @example
* Example usage:
*
* ```js

@@ -373,3 +374,4 @@ * const directoryClient = shareClient.getDirectoryClient("<directory name>");

*
* @example
* Example usage:
*
* ```js

@@ -533,16 +535,21 @@ * const content = "Hello world!"

switch (_a.label) {
case 0: return [4 /*yield*/, __await(this.listFilesAndDirectoriesSegment(marker, options))];
case 1:
case 0:
if (options.prefix === "") {
options.prefix = undefined;
}
_a.label = 1;
case 1: return [4 /*yield*/, __await(this.listFilesAndDirectoriesSegment(marker, options))];
case 2:
listFilesAndDirectoriesResponse = _a.sent();
marker = listFilesAndDirectoriesResponse.continuationToken;
return [4 /*yield*/, __await(listFilesAndDirectoriesResponse)];
case 2: return [4 /*yield*/, __await.apply(void 0, [_a.sent()])];
case 3: return [4 /*yield*/, _a.sent()];
case 4:
case 3: return [4 /*yield*/, __await.apply(void 0, [_a.sent()])];
case 4: return [4 /*yield*/, _a.sent()];
case 5:
_a.sent();
_a.label = 5;
case 5:
if (marker) return [3 /*break*/, 0];
_a.label = 6;
case 6: return [2 /*return*/];
case 6:
if (marker) return [3 /*break*/, 1];
_a.label = 7;
case 7: return [2 /*return*/];
}

@@ -568,55 +575,60 @@ });

case 0:
_g.trys.push([0, 14, 15, 20]);
if (options.prefix === "") {
options.prefix = undefined;
}
_g.label = 1;
case 1:
_g.trys.push([1, 15, 16, 21]);
_a = __asyncValues(this.iterateFilesAndDirectoriesSegments(marker, options));
_g.label = 1;
case 1: return [4 /*yield*/, __await(_a.next())];
case 2:
if (!(_b = _g.sent(), !_b.done)) return [3 /*break*/, 13];
_g.label = 2;
case 2: return [4 /*yield*/, __await(_a.next())];
case 3:
if (!(_b = _g.sent(), !_b.done)) return [3 /*break*/, 14];
listFilesAndDirectoriesResponse = _b.value;
_i = 0, _c = listFilesAndDirectoriesResponse.segment.fileItems;
_g.label = 3;
case 3:
if (!(_i < _c.length)) return [3 /*break*/, 7];
_g.label = 4;
case 4:
if (!(_i < _c.length)) return [3 /*break*/, 8];
file = _c[_i];
return [4 /*yield*/, __await(__assign({ kind: "file" }, file))];
case 4: return [4 /*yield*/, _g.sent()];
case 5:
case 5: return [4 /*yield*/, _g.sent()];
case 6:
_g.sent();
_g.label = 6;
case 6:
_g.label = 7;
case 7:
_i++;
return [3 /*break*/, 3];
case 7:
return [3 /*break*/, 4];
case 8:
_d = 0, _e = listFilesAndDirectoriesResponse.segment.directoryItems;
_g.label = 8;
case 8:
if (!(_d < _e.length)) return [3 /*break*/, 12];
_g.label = 9;
case 9:
if (!(_d < _e.length)) return [3 /*break*/, 13];
directory = _e[_d];
return [4 /*yield*/, __await(__assign({ kind: "directory" }, directory))];
case 9: return [4 /*yield*/, _g.sent()];
case 10:
case 10: return [4 /*yield*/, _g.sent()];
case 11:
_g.sent();
_g.label = 11;
case 11:
_g.label = 12;
case 12:
_d++;
return [3 /*break*/, 8];
case 12: return [3 /*break*/, 1];
case 13: return [3 /*break*/, 20];
case 14:
return [3 /*break*/, 9];
case 13: return [3 /*break*/, 2];
case 14: return [3 /*break*/, 21];
case 15:
e_10_1 = _g.sent();
e_10 = { error: e_10_1 };
return [3 /*break*/, 20];
case 15:
_g.trys.push([15, , 18, 19]);
if (!(_b && !_b.done && (_f = _a.return))) return [3 /*break*/, 17];
return [3 /*break*/, 21];
case 16:
_g.trys.push([16, , 19, 20]);
if (!(_b && !_b.done && (_f = _a.return))) return [3 /*break*/, 18];
return [4 /*yield*/, __await(_f.call(_a))];
case 16:
case 17:
_g.sent();
_g.label = 17;
case 17: return [3 /*break*/, 19];
case 18:
_g.label = 18;
case 18: return [3 /*break*/, 20];
case 19:
if (e_10) throw e_10.error;
return [7 /*endfinally*/];
case 19: return [7 /*endfinally*/];
case 20: return [2 /*return*/];
case 20: return [7 /*endfinally*/];
case 21: return [2 /*return*/];
}

@@ -632,54 +644,39 @@ });

*
* @example
* ```js
* let i = 1;
* for await (const entity of directoryClient.listFilesAndDirectories()) {
* if (entity.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.name}`);
* }
* }
* ```
* Example using `for await` syntax:
*
* @example
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await directoryClient.listFilesAndDirectories();
* let entity = await iter.next();
* while (!entity.done) {
* if (entity.value.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.value.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.value.name}`);
* }
* entity = await iter.next();
* let i = 1;
* for await (const entity of directoryClient.listFilesAndDirectories()) {
* if (entity.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.name}`);
* }
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of directoryClient
* .listFilesAndDirectories()
* .byPage({ maxPageSize: 20 })) {
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* let i = 1;
* let iter = await directoryClient.listFilesAndDirectories();
* let entity = await iter.next();
* while (!entity.done) {
* if (entity.value.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.value.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.value.name}`);
* }
* entity = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 });
* let response = (await iterator.next()).value;
* // Prints 3 file and directory names
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of directoryClient
* .listFilesAndDirectories()
* .byPage({ maxPageSize: 20 })) {
* for (const fileItem of response.segment.fileItems) {

@@ -691,18 +688,40 @@ * console.log(`${i++} - file\t: ${fileItem.name}`);

* }
* // Gets next marker
* let dirMarker = response.continuationToken;
* // Passing next marker as continuationToken
* iterator = directoryClient
* .listFilesAndDirectories()
* .byPage({ continuationToken: dirMarker, maxPageSize: 4 });
* response = (await iterator.next()).value;
* // Prints 10 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* }
* ```
*
* Example using paging with a marker:
*
* ```js
* let i = 1;
* let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 });
* let response = (await iterator.next()).value;
*
* // Prints 3 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
*
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
*
* // Gets next marker
* let dirMarker = response.continuationToken;
*
* // Passing next marker as continuationToken
* iterator = directoryClient
* .listFilesAndDirectories()
* .byPage({ continuationToken: dirMarker, maxPageSize: 4 });
* response = (await iterator.next()).value;
*
* // Prints 10 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
*
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* ```
*
* @param {DirectoryListFilesAndDirectoriesOptions} [options] Options to list files and directories operation.

@@ -717,2 +736,5 @@ * @memberof ShareDirectoryClient

if (options === void 0) { options = {}; }
if (options.prefix === "") {
options.prefix = undefined;
}
// AsyncIterableIterator to iterate over files and directories

@@ -765,2 +787,5 @@ var iter = this.listFilesAndDirectoriesItems(options);

_a = createSpan("ShareDirectoryClient-listFilesAndDirectoriesSegment", options.tracingOptions), span = _a.span, spanOptions = _a.spanOptions;
if (options.prefix === "") {
options.prefix = undefined;
}
_b.label = 1;

@@ -892,61 +917,66 @@ case 1:

*
* @example
* Example using `for await` syntax:
*
* ```js
* let i = 1;
* let iter = dirClient.listHandles();
* for await (const handle of iter) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* let i = 1;
* let iter = dirClient.listHandles();
* for await (const handle of iter) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await dirClient.listHandles();
* let handleItem = await iter.next();
* while (!handleItem.done) {
* console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`);
* handleItem = await iter.next();
* }
* let i = 1;
* let iter = await dirClient.listHandles();
* let handleItem = await iter.next();
* while (!handleItem.done) {
* console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`);
* handleItem = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) {
* if (response.handleList) {
* for (const handle of response.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) {
* if (response.handleList) {
* for (const handle of response.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
* }
* ```
*
* @example
* Example using paging with a marker:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 });
* let response = await iterator.next();
* // Prints 2 handles
* if (response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* let i = 1;
* let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 });
* let response = await iterator.next();
*
* // Prints 2 handles
* if (response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* // Gets next marker
* let marker = response.value.continuationToken;
* // Passing next marker as continuationToken
* console.log(` continuation`);
* iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = await iterator.next();
* // Prints 2 more handles assuming you have more than four directory/files opened
* if (!response.done && response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
*
* // Gets next marker
* let marker = response.value.continuationToken;
*
* // Passing next marker as continuationToken
* console.log(` continuation`);
* iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = await iterator.next();
*
* // Prints 2 more handles assuming you have more than four directory/files opened
* if (!response.done && response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
* ```

@@ -953,0 +983,0 @@ *

170

dist-esm/src/ShareServiceClient.js

@@ -83,3 +83,4 @@ // Copyright (c) Microsoft Corporation. All rights reserved.

*
* @example
* Example usage:
*
* ```js

@@ -275,16 +276,21 @@ * const shareClient = serviceClient.getShareClient("<share name>");

switch (_a.label) {
case 0: return [4 /*yield*/, __await(this.listSharesSegment(marker, options))];
case 1:
case 0:
if (options.prefix === "") {
options.prefix = undefined;
}
_a.label = 1;
case 1: return [4 /*yield*/, __await(this.listSharesSegment(marker, options))];
case 2:
listSharesSegmentResponse = _a.sent();
marker = listSharesSegmentResponse.continuationToken;
return [4 /*yield*/, __await(listSharesSegmentResponse)];
case 2: return [4 /*yield*/, __await.apply(void 0, [_a.sent()])];
case 3: return [4 /*yield*/, _a.sent()];
case 4:
case 3: return [4 /*yield*/, __await.apply(void 0, [_a.sent()])];
case 4: return [4 /*yield*/, _a.sent()];
case 5:
_a.sent();
_a.label = 5;
case 5:
if (marker) return [3 /*break*/, 0];
_a.label = 6;
case 6: return [2 /*return*/];
case 6:
if (marker) return [3 /*break*/, 1];
_a.label = 7;
case 7: return [2 /*return*/];
}

@@ -310,33 +316,38 @@ });

case 0:
_d.trys.push([0, 7, 8, 13]);
if (options.prefix === "") {
options.prefix = undefined;
}
_d.label = 1;
case 1:
_d.trys.push([1, 8, 9, 14]);
_a = __asyncValues(this.listSegments(marker, options));
_d.label = 1;
case 1: return [4 /*yield*/, __await(_a.next())];
case 2:
if (!(_b = _d.sent(), !_b.done)) return [3 /*break*/, 6];
_d.label = 2;
case 2: return [4 /*yield*/, __await(_a.next())];
case 3:
if (!(_b = _d.sent(), !_b.done)) return [3 /*break*/, 7];
segment = _b.value;
return [5 /*yield**/, __values(__asyncDelegator(__asyncValues(segment.shareItems)))];
case 3: return [4 /*yield*/, __await.apply(void 0, [_d.sent()])];
case 4:
case 4: return [4 /*yield*/, __await.apply(void 0, [_d.sent()])];
case 5:
_d.sent();
_d.label = 5;
case 5: return [3 /*break*/, 1];
case 6: return [3 /*break*/, 13];
case 7:
_d.label = 6;
case 6: return [3 /*break*/, 2];
case 7: return [3 /*break*/, 14];
case 8:
e_5_1 = _d.sent();
e_5 = { error: e_5_1 };
return [3 /*break*/, 13];
case 8:
_d.trys.push([8, , 11, 12]);
if (!(_b && !_b.done && (_c = _a.return))) return [3 /*break*/, 10];
return [3 /*break*/, 14];
case 9:
_d.trys.push([9, , 12, 13]);
if (!(_b && !_b.done && (_c = _a.return))) return [3 /*break*/, 11];
return [4 /*yield*/, __await(_c.call(_a))];
case 9:
case 10:
_d.sent();
_d.label = 10;
case 10: return [3 /*break*/, 12];
case 11:
_d.label = 11;
case 11: return [3 /*break*/, 13];
case 12:
if (e_5) throw e_5.error;
return [7 /*endfinally*/];
case 12: return [7 /*endfinally*/];
case 13: return [2 /*return*/];
case 13: return [7 /*endfinally*/];
case 14: return [2 /*return*/];
}

@@ -352,59 +363,64 @@ });

*
* @example
* Example using `for await` syntax:
*
* ```js
* let i = 1;
* for await (const share of serviceClient.listShares()) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* let i = 1;
* for await (const share of serviceClient.listShares()) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await serviceClient.listShares();
* let shareItem = await iter.next();
* while (!shareItem.done) {
* console.log(`Share ${i++}: ${shareItem.value.name}`);
* shareItem = await iter.next();
* }
* let i = 1;
* let iter = await serviceClient.listShares();
* let shareItem = await iter.next();
* while (!shareItem.done) {
* console.log(`Share ${i++}: ${shareItem.value.name}`);
* shareItem = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
* }
* ```
*
* @example
* Example using paging with a marker:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
* let response = (await iterator.next()).value;
* // Prints 2 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* let i = 1;
* let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
* let response = (await iterator.next()).value;
*
* // Prints 2 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* // Gets next marker
* let marker = response.continuationToken;
* // Passing next marker as continuationToken
* iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = (await iterator.next()).value;
* // Prints 10 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
*
* // Gets next marker
* let marker = response.continuationToken;
*
* // Passing next marker as continuationToken
* iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = (await iterator.next()).value;
*
* // Prints 10 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
* ```

@@ -421,2 +437,5 @@ *

if (options === void 0) { options = {}; }
if (options.prefix === "") {
options.prefix = undefined;
}
var include = [];

@@ -477,2 +496,5 @@ if (options.includeMetadata) {

_a = createSpan("ShareServiceClient-listSharesSegment", options.tracingOptions), span = _a.span, spanOptions = _a.spanOptions;
if (options.prefix === "") {
options.prefix = undefined;
}
_b.label = 1;

@@ -479,0 +501,0 @@ case 1:

2

package.json
{
"name": "@azure/storage-file-share",
"sdk-type": "client",
"version": "12.0.0-dev.20191122.1",
"version": "12.0.0-dev.20191123.1",
"description": "Microsoft Azure Storage SDK for JavaScript - File",

@@ -6,0 +6,0 @@ "main": "./dist/index.js",

243

src/ShareDirectoryClient.ts

@@ -502,3 +502,4 @@ // Copyright (c) Microsoft Corporation. All rights reserved.

*
* @example
* Example usage:
*
* ```js

@@ -684,3 +685,4 @@ * const directoryClient = shareClient.getDirectoryClient("<directory name>");

*
* @example
* Example usage:
*
* ```js

@@ -818,2 +820,6 @@ * const content = "Hello world!"

): AsyncIterableIterator<DirectoryListFilesAndDirectoriesSegmentResponse> {
if (options.prefix === "") {
options.prefix = undefined;
}
let listFilesAndDirectoriesResponse;

@@ -837,3 +843,9 @@ do {

options: DirectoryListFilesAndDirectoriesSegmentOptions = {}
): AsyncIterableIterator<{ kind: "file" } & FileItem | { kind: "directory" } & DirectoryItem> {
): AsyncIterableIterator<
({ kind: "file" } & FileItem) | ({ kind: "directory" } & DirectoryItem)
> {
if (options.prefix === "") {
options.prefix = undefined;
}
let marker: string | undefined;

@@ -859,54 +871,39 @@ for await (const listFilesAndDirectoriesResponse of this.iterateFilesAndDirectoriesSegments(

*
* @example
* ```js
* let i = 1;
* for await (const entity of directoryClient.listFilesAndDirectories()) {
* if (entity.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.name}`);
* }
* }
* ```
* Example using `for await` syntax:
*
* @example
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await directoryClient.listFilesAndDirectories();
* let entity = await iter.next();
* while (!entity.done) {
* if (entity.value.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.value.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.value.name}`);
* }
* entity = await iter.next();
* let i = 1;
* for await (const entity of directoryClient.listFilesAndDirectories()) {
* if (entity.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.name}`);
* }
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of directoryClient
* .listFilesAndDirectories()
* .byPage({ maxPageSize: 20 })) {
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* let i = 1;
* let iter = await directoryClient.listFilesAndDirectories();
* let entity = await iter.next();
* while (!entity.done) {
* if (entity.value.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.value.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.value.name}`);
* }
* entity = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 });
* let response = (await iterator.next()).value;
* // Prints 3 file and directory names
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of directoryClient
* .listFilesAndDirectories()
* .byPage({ maxPageSize: 20 })) {
* for (const fileItem of response.segment.fileItems) {

@@ -918,18 +915,40 @@ * console.log(`${i++} - file\t: ${fileItem.name}`);

* }
* // Gets next marker
* let dirMarker = response.continuationToken;
* // Passing next marker as continuationToken
* iterator = directoryClient
* .listFilesAndDirectories()
* .byPage({ continuationToken: dirMarker, maxPageSize: 4 });
* response = (await iterator.next()).value;
* // Prints 10 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* }
* ```
*
* Example using paging with a marker:
*
* ```js
* let i = 1;
* let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 });
* let response = (await iterator.next()).value;
*
* // Prints 3 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
*
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
*
* // Gets next marker
* let dirMarker = response.continuationToken;
*
* // Passing next marker as continuationToken
* iterator = directoryClient
* .listFilesAndDirectories()
* .byPage({ continuationToken: dirMarker, maxPageSize: 4 });
* response = (await iterator.next()).value;
*
* // Prints 10 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
*
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* ```
*
* @param {DirectoryListFilesAndDirectoriesOptions} [options] Options to list files and directories operation.

@@ -943,5 +962,9 @@ * @memberof ShareDirectoryClient

): PagedAsyncIterableIterator<
{ kind: "file" } & FileItem | { kind: "directory" } & DirectoryItem,
({ kind: "file" } & FileItem) | ({ kind: "directory" } & DirectoryItem),
DirectoryListFilesAndDirectoriesSegmentResponse
> {
if (options.prefix === "") {
options.prefix = undefined;
}
// AsyncIterableIterator to iterate over files and directories

@@ -992,2 +1015,7 @@ const iter = this.listFilesAndDirectoriesItems(options);

);
if (options.prefix === "") {
options.prefix = undefined;
}
try {

@@ -1064,61 +1092,66 @@ return await this.context.listFilesAndDirectoriesSegment({

*
* @example
* Example using `for await` syntax:
*
* ```js
* let i = 1;
* let iter = dirClient.listHandles();
* for await (const handle of iter) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* let i = 1;
* let iter = dirClient.listHandles();
* for await (const handle of iter) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await dirClient.listHandles();
* let handleItem = await iter.next();
* while (!handleItem.done) {
* console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`);
* handleItem = await iter.next();
* }
* let i = 1;
* let iter = await dirClient.listHandles();
* let handleItem = await iter.next();
* while (!handleItem.done) {
* console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`);
* handleItem = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) {
* if (response.handleList) {
* for (const handle of response.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) {
* if (response.handleList) {
* for (const handle of response.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
* }
* ```
*
* @example
* Example using paging with a marker:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 });
* let response = await iterator.next();
* // Prints 2 handles
* if (response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* let i = 1;
* let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 });
* let response = await iterator.next();
*
* // Prints 2 handles
* if (response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* // Gets next marker
* let marker = response.value.continuationToken;
* // Passing next marker as continuationToken
* console.log(` continuation`);
* iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = await iterator.next();
* // Prints 2 more handles assuming you have more than four directory/files opened
* if (!response.done && response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
*
* // Gets next marker
* let marker = response.value.continuationToken;
*
* // Passing next marker as continuationToken
* console.log(` continuation`);
* iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = await iterator.next();
*
* // Prints 2 more handles assuming you have more than four directory/files opened
* if (!response.done && response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
* ```

@@ -1125,0 +1158,0 @@ *

111

src/ShareServiceClient.ts

@@ -257,3 +257,4 @@ // Copyright (c) Microsoft Corporation. All rights reserved.

*
* @example
* Example usage:
*
* ```js

@@ -424,2 +425,6 @@ * const shareClient = serviceClient.getShareClient("<share name>");

): AsyncIterableIterator<ServiceListSharesSegmentResponse> {
if (options.prefix === "") {
options.prefix = undefined;
}
let listSharesSegmentResponse;

@@ -444,2 +449,6 @@ do {

): AsyncIterableIterator<ShareItem> {
if (options.prefix === "") {
options.prefix = undefined;
}
let marker: string | undefined;

@@ -457,59 +466,64 @@ for await (const segment of this.listSegments(marker, options)) {

*
* @example
* Example using `for await` syntax:
*
* ```js
* let i = 1;
* for await (const share of serviceClient.listShares()) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* let i = 1;
* for await (const share of serviceClient.listShares()) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await serviceClient.listShares();
* let shareItem = await iter.next();
* while (!shareItem.done) {
* console.log(`Share ${i++}: ${shareItem.value.name}`);
* shareItem = await iter.next();
* }
* let i = 1;
* let iter = await serviceClient.listShares();
* let shareItem = await iter.next();
* while (!shareItem.done) {
* console.log(`Share ${i++}: ${shareItem.value.name}`);
* shareItem = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
* }
* ```
*
* @example
* Example using paging with a marker:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
* let response = (await iterator.next()).value;
* // Prints 2 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* let i = 1;
* let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
* let response = (await iterator.next()).value;
*
* // Prints 2 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* // Gets next marker
* let marker = response.continuationToken;
* // Passing next marker as continuationToken
* iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = (await iterator.next()).value;
* // Prints 10 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
*
* // Gets next marker
* let marker = response.continuationToken;
*
* // Passing next marker as continuationToken
* iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = (await iterator.next()).value;
*
* // Prints 10 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
* ```

@@ -525,2 +539,6 @@ *

): PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse> {
if (options.prefix === "") {
options.prefix = undefined;
}
const include: ListSharesIncludeType[] = [];

@@ -588,2 +606,7 @@ if (options.includeMetadata) {

);
if (options.prefix === "") {
options.prefix = undefined;
}
try {

@@ -590,0 +613,0 @@ return await this.serviceContext.listSharesSegment({

226

typings/src/ShareDirectoryClient.d.ts

@@ -319,3 +319,4 @@ import { AbortSignalLike } from "@azure/abort-controller";

*
* @example
* Example usage:
*
* ```js

@@ -393,3 +394,4 @@ * const directoryClient = shareClient.getDirectoryClient("<directory name>");

*
* @example
* Example usage:
*
* ```js

@@ -470,54 +472,39 @@ * const content = "Hello world!"

*
* @example
* ```js
* let i = 1;
* for await (const entity of directoryClient.listFilesAndDirectories()) {
* if (entity.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.name}`);
* }
* }
* ```
* Example using `for await` syntax:
*
* @example
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await directoryClient.listFilesAndDirectories();
* let entity = await iter.next();
* while (!entity.done) {
* if (entity.value.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.value.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.value.name}`);
* }
* entity = await iter.next();
* let i = 1;
* for await (const entity of directoryClient.listFilesAndDirectories()) {
* if (entity.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.name}`);
* }
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of directoryClient
* .listFilesAndDirectories()
* .byPage({ maxPageSize: 20 })) {
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* let i = 1;
* let iter = await directoryClient.listFilesAndDirectories();
* let entity = await iter.next();
* while (!entity.done) {
* if (entity.value.kind === "directory") {
* console.log(`${i++} - directory\t: ${entity.value.name}`);
* } else {
* console.log(`${i++} - file\t: ${entity.value.name}`);
* }
* entity = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 });
* let response = (await iterator.next()).value;
* // Prints 3 file and directory names
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of directoryClient
* .listFilesAndDirectories()
* .byPage({ maxPageSize: 20 })) {
* for (const fileItem of response.segment.fileItems) {

@@ -529,18 +516,40 @@ * console.log(`${i++} - file\t: ${fileItem.name}`);

* }
* // Gets next marker
* let dirMarker = response.continuationToken;
* // Passing next marker as continuationToken
* iterator = directoryClient
* .listFilesAndDirectories()
* .byPage({ continuationToken: dirMarker, maxPageSize: 4 });
* response = (await iterator.next()).value;
* // Prints 10 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* }
* ```
*
* Example using paging with a marker:
*
* ```js
* let i = 1;
* let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 });
* let response = (await iterator.next()).value;
*
* // Prints 3 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
*
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
*
* // Gets next marker
* let dirMarker = response.continuationToken;
*
* // Passing next marker as continuationToken
* iterator = directoryClient
* .listFilesAndDirectories()
* .byPage({ continuationToken: dirMarker, maxPageSize: 4 });
* response = (await iterator.next()).value;
*
* // Prints 10 file and directory names
* for (const fileItem of response.segment.fileItems) {
* console.log(`${i++} - file\t: ${fileItem.name}`);
* }
*
* for (const dirItem of response.segment.directoryItems) {
* console.log(`${i++} - directory\t: ${dirItem.name}`);
* }
* ```
*
* @param {DirectoryListFilesAndDirectoriesOptions} [options] Options to list files and directories operation.

@@ -551,7 +560,7 @@ * @memberof ShareDirectoryClient

*/
listFilesAndDirectories(options?: DirectoryListFilesAndDirectoriesOptions): PagedAsyncIterableIterator<{
listFilesAndDirectories(options?: DirectoryListFilesAndDirectoriesOptions): PagedAsyncIterableIterator<({
kind: "file";
} & FileItem | {
} & FileItem) | ({
kind: "directory";
} & DirectoryItem, DirectoryListFilesAndDirectoriesSegmentResponse>;
} & DirectoryItem), DirectoryListFilesAndDirectoriesSegmentResponse>;
/**

@@ -597,61 +606,66 @@ * Returns a list of files or directories under the specified share or directory. It lists the

*
* @example
* Example using `for await` syntax:
*
* ```js
* let i = 1;
* let iter = dirClient.listHandles();
* for await (const handle of iter) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* let i = 1;
* let iter = dirClient.listHandles();
* for await (const handle of iter) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await dirClient.listHandles();
* let handleItem = await iter.next();
* while (!handleItem.done) {
* console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`);
* handleItem = await iter.next();
* }
* let i = 1;
* let iter = await dirClient.listHandles();
* let handleItem = await iter.next();
* while (!handleItem.done) {
* console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`);
* handleItem = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) {
* if (response.handleList) {
* for (const handle of response.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) {
* if (response.handleList) {
* for (const handle of response.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
* }
* ```
*
* @example
* Example using paging with a marker:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 });
* let response = await iterator.next();
* // Prints 2 handles
* if (response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* let i = 1;
* let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 });
* let response = await iterator.next();
*
* // Prints 2 handles
* if (response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* // Gets next marker
* let marker = response.value.continuationToken;
* // Passing next marker as continuationToken
* console.log(` continuation`);
* iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = await iterator.next();
* // Prints 2 more handles assuming you have more than four directory/files opened
* if (!response.done && response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
*
* // Gets next marker
* let marker = response.value.continuationToken;
*
* // Passing next marker as continuationToken
* console.log(` continuation`);
* iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = await iterator.next();
*
* // Prints 2 more handles assuming you have more than four directory/files opened
* if (!response.done && response.value.handleList) {
* for (const handle of response.value.handleList) {
* console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
* }
* }
* ```

@@ -658,0 +672,0 @@ *

20

typings/src/ShareFileClient.d.ts

@@ -658,3 +658,4 @@ /// <reference types="node" />

*
* @example
* Example usage:
*
* ```js

@@ -687,5 +688,6 @@ * const content = "Hello world!";

*
* @example
* Example usage (Node.js):
*
* ```js
* // Download a file to a string (Node.js only)
* // Download a file to a string
* const downloadFileResponse = await fileClient.download();

@@ -697,3 +699,3 @@ * console.log(

*
* // [Node.js only] A helper method used to read a Node.js readable stream into string
* // A helper method used to read a Node.js readable stream into string
* async function streamToString(readableStream) {

@@ -713,5 +715,6 @@ * return new Promise((resolve, reject) => {

*
* @example
* Example usage (browsers):
*
* ```js
* // Download a file to a string (Browser only)
* // Download a file to a string
* const downloadFileResponse = await fileClient.download(0);

@@ -723,3 +726,3 @@ * console.log(

*
* // [Browser only] A helper method used to convert a browser Blob into string.
* // A helper method used to convert a browser Blob into string.
* export async function blobToString(blob: Blob): Promise<string> {

@@ -832,3 +835,4 @@ * const fileReader = new FileReader();

*
* @example
* Example usage:
*
* ```js

@@ -835,0 +839,0 @@ * const content = "Hello world!";

94

typings/src/ShareServiceClient.d.ts

@@ -140,3 +140,4 @@ import { AbortSignalLike } from "@azure/abort-controller";

*
* @example
* Example usage:
*
* ```js

@@ -222,59 +223,64 @@ * const shareClient = serviceClient.getShareClient("<share name>");

*
* @example
* Example using `for await` syntax:
*
* ```js
* let i = 1;
* for await (const share of serviceClient.listShares()) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* let i = 1;
* for await (const share of serviceClient.listShares()) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* ```
*
* @example
* Example using `iter.next()`:
*
* ```js
* // Generator syntax .next()
* let i = 1;
* let iter = await serviceClient.listShares();
* let shareItem = await iter.next();
* while (!shareItem.done) {
* console.log(`Share ${i++}: ${shareItem.value.name}`);
* shareItem = await iter.next();
* }
* let i = 1;
* let iter = await serviceClient.listShares();
* let shareItem = await iter.next();
* while (!shareItem.done) {
* console.log(`Share ${i++}: ${shareItem.value.name}`);
* shareItem = await iter.next();
* }
* ```
*
* @example
* Example using `byPage()`:
*
* ```js
* // Example for .byPage()
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* // passing optional maxPageSize in the page settings
* let i = 1;
* for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
* }
* ```
*
* @example
* Example using paging with a marker:
*
* ```js
* // Passing marker as an argument (similar to the previous example)
* let i = 1;
* let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
* let response = (await iterator.next()).value;
* // Prints 2 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* let i = 1;
* let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
* let response = (await iterator.next()).value;
*
* // Prints 2 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* // Gets next marker
* let marker = response.continuationToken;
* // Passing next marker as continuationToken
* iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = (await iterator.next()).value;
* // Prints 10 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
*
* // Gets next marker
* let marker = response.continuationToken;
*
* // Passing next marker as continuationToken
* iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
* response = (await iterator.next()).value;
*
* // Prints 10 share names
* if (response.shareItems) {
* for (const share of response.shareItems) {
* console.log(`Share ${i++}: ${share.name}`);
* }
* }
* ```

@@ -281,0 +287,0 @@ *

dist-esm/src/ShareDirectoryClient.js.map

Sorry, the diff of this file is not supported yet

dist-esm/src/ShareFileClient.js

Sorry, the diff of this file is too big to display

dist-esm/src/ShareFileClient.js.map

Sorry, the diff of this file is not supported yet

dist-esm/src/ShareServiceClient.js.map

Sorry, the diff of this file is not supported yet

dist/index.js

Sorry, the diff of this file is too big to display

dist/index.js.map

Sorry, the diff of this file is not supported yet

src/ShareFileClient.ts

Sorry, the diff of this file is too big to display

typings/src/ShareDirectoryClient.d.ts.map

Sorry, the diff of this file is not supported yet

typings/src/ShareFileClient.d.ts.map

Sorry, the diff of this file is not supported yet

typings/src/ShareServiceClient.d.ts.map

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc