This class holds helper functions that are used to delete files through the z/OSMF APIs.

### Hierarchy

- Delete

## Index

### Methods

- dataSet
- ussFile
- vsam
- zfs

## Methods

### Static dataSet

- dataSet(session: AbstractSession, dataSetName: string, options?: IDeleteDatasetOptions): Promise<IZosFilesResponse>

- - Defined in @zowe/zos-files-for-zowe-sdk/src/methods/delete/Delete.ts:47

  Deletes a non-VSAM data set

  throws

    {ImperativeError} Data set name must be specified as a non-empty string

  throws

    {Error} When the ZosmfRestClient throws an error

  see

    https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua700/IZUHPINFO_API_DeleteDataSet.htm

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### dataSetName: string

    The name of the data set to delete

  - ##### Default value options: IDeleteDatasetOptions = {}

  #### Returns Promise<IZosFilesResponse>

  A response indicating the status of the deletion

### Static ussFile

- ussFile(session: AbstractSession, fileName: string, recursive?: boolean, options?: IZosFilesOptions): Promise<IZosFilesResponse>

- - Defined in @zowe/zos-files-for-zowe-sdk/src/methods/delete/Delete.ts:141

  Deletes a USS file or directory

  throws

    {ImperativeError} Data set name must be specified as a non-empty string

  see

    https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.3.0/com.ibm.zos.v2r3.izua700/IZUHPINFO_API_DeleteUnixFile.htm

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### fileName: string

    The name of the file or directory to delete

  - ##### Optional recursive: boolean

    The indicator to delete directory recursively

  - ##### Optional options: IZosFilesOptions

  #### Returns Promise<IZosFilesResponse>

  A response indicating the status of the deletion

### Static vsam

- vsam(session: AbstractSession, dataSetName: string, options?: IDeleteVsamOptions): Promise<IDeleteVsamResponse>

- - Defined in @zowe/zos-files-for-zowe-sdk/src/methods/delete/Delete.ts:99

  Deletes a VSAM data set

  throws

    {ImperativeError} Data set name must be specified as a non-empty string

  see

    https://www.ibm.com/support/knowledgecenter/SSLTBW_2.1.0/com.ibm.zos.v2r1.idai200/delet.htm

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### dataSetName: string

    The name of the VSAM data set to delete

  - ##### Default value options: IDeleteVsamOptions = {}

  #### Returns Promise<IDeleteVsamResponse>

  A response indicating the status of the deletion

### Static zfs

- zfs(session: AbstractSession, fileSystemName: string, options?: IZosFilesOptions): Promise<IZosFilesResponse>

- - Defined in @zowe/zos-files-for-zowe-sdk/src/methods/delete/Delete.ts:186

  Deletes a z/OS file system

  throws

    {ImperativeError} File system name must be specified as a non-empty string

  see

    https://www.ibm.com/support/knowledgecenter/SSLTBW_2.1.0/com.ibm.zos.v2r1.izua700/IZUHPINFO_API_DeleteUnixzFsFilesystem.htm

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  - ##### fileSystemName: string

    The name of the ZFS to delete

  - ##### Optional options: IZosFilesOptions

  #### Returns Promise<IZosFilesResponse>

Generated using TypeDoc