Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FileSystemAttributes

Package version

This is a helper class to construct a string representing the NTFS attributes to a file or directory.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes

Hierarchy

  • FileSystemAttributes

Index

Properties

archive

archive: boolean = false

Specifies a directory or file is an archive. Applications typically use this attribute to mark files for backup or removal.

directory

directory: boolean = false

Specifies the handle identifies a directory.

hidden

hidden: boolean = false

Specifies a directory or file is hidden.

noScrubData

noScrubData: boolean = false

Specifies the user data stream not to be read by the background data integrity scanner. This file system attribute is presented primarily to provide compatibility with Windows. Applicable to directory or file.

none

none: boolean = false

Specifies a directory or file that does not have other attributes set. This attribute is valid only when used alone.

notContentIndexed

notContentIndexed: boolean = false

Specifies the directory or file is not to be indexed by the content indexing service.

offline

offline: boolean = false

Specifies the data of a directory or file is not available immediately. This file system attribute is presented primarily to provide compatibility with Windows - Azure Files does not support with offline storage options.

readonly

readonly: boolean = false

Specifies a directory or file that is read-only.

system

system: boolean = false

Specifies a directory or file that the operating system uses a part of, or uses exclusively.

temporary

temporary: boolean = false

Specifies if a file is temporary.

Methods

toString

  • toString(): string
  • Converts the given attributes to a string.

    Returns string

    A string which represents the FileSystemAttributes

Static parse

  • Creates a FileSystemAttributes from the specified attributes string. This method will throw an Error if it encounters a string that does not correspond to a valid attributes.

    Parameters

    • fileAttributes: string

      The value of header x-ms-file-attributes.

    Returns FileSystemAttributes

Generated using TypeDoc