azure-storage-js/file/lib/FileSASPermissions.ts

104 строки
2.7 KiB
TypeScript

/**
* 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 ServiceSASSignatureValues} 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.
*
* @export
* @class FileSASPermissions
*/
export 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.
*
* @static
* @param {string} permissions
* @returns {FileSASPermissions}
* @memberof FileSASPermissions
*/
public static parse(permissions: string): FileSASPermissions {
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.
*
* @type {boolean}
* @memberof FileSASPermissions
*/
public read: boolean = false;
/**
* Specifies Create access granted.
*
* @type {boolean}
* @memberof FileSASPermissions
*/
public create: boolean = false;
/**
* Specifies Write access granted.
*
* @type {boolean}
* @memberof FileSASPermissions
*/
public write: boolean = false;
/**
* Specifies Delete access granted.
*
* @type {boolean}
* @memberof FileSASPermissions
*/
public delete: boolean = false;
/**
* Converts the given permissions to a string. Using this method will guarantee the permissions are in an
* order accepted by the service.
*
* @returns {string} A string which represents the FileSASPermissions
* @memberof FileSASPermissions
*/
public toString(): string {
const permissions: string[] = [];
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("");
}
}