@azure/storage-file-share
Version:
Microsoft Azure Storage SDK for JavaScript - File
84 lines • 2.81 kB
JavaScript
;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.FileSASPermissions = void 0;
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a file. Setting
* a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
* the values are set, this should be serialized with toString and set as the permissions field on a
* {@link FileSASSignatureValues} object. It is possible to construct the permissions string without this class, but
* the order of the permissions is particular and this class guarantees correctness.
*/
class FileSASPermissions {
/**
* Creates a FileSASPermissions from the specified permissions string. This method will throw an
* Error if it encounters a character that does not correspond to a valid permission.
*
* @param permissions -
*/
static parse(permissions) {
const fileSASPermissions = new FileSASPermissions();
for (const char of permissions) {
switch (char) {
case "r":
fileSASPermissions.read = true;
break;
case "c":
fileSASPermissions.create = true;
break;
case "w":
fileSASPermissions.write = true;
break;
case "d":
fileSASPermissions.delete = true;
break;
default:
throw new RangeError(`Invalid permission: ${char}`);
}
}
return fileSASPermissions;
}
/**
* Specifies Read access granted.
*/
read = false;
/**
* Specifies Create access granted.
*/
create = false;
/**
* Specifies Write access granted.
*/
write = false;
/**
* Specifies Delete access granted.
*/
delete = false;
/**
* Converts the given permissions to a string. Using this method will guarantee the permissions are in an
* order accepted by the service.
*
* @returns A string which represents the FileSASPermissions
*/
toString() {
const permissions = [];
if (this.read) {
permissions.push("r");
}
if (this.create) {
permissions.push("c");
}
if (this.write) {
permissions.push("w");
}
if (this.delete) {
permissions.push("d");
}
return permissions.join("");
}
}
exports.FileSASPermissions = FileSASPermissions;
//# sourceMappingURL=FileSASPermissions.js.map