FileSystemManager-rmdir

FileSystemManager.rmdir

Requires:

BaseKit≥2.4.3

Platforms:

iOSAndroid

Method signature

FileSystemManager.rmdir(params: )

Description

Delete a directory; requires file read/write permissions

Parameters

Property	Type	Required	Description
`dirPath`	string	Yes	Path of the directory to delete (local path)
`recursive`	boolean	No	Whether to delete the directory recursively. If true, deletes the directory and all its subdirectories and files. Default: false
`complete`	() => void	No	Completion callback (executed on both success and failure)
`success`	() => void	No	Callback on successful API call
`fail`	(params: Object) => void	No	Failure callback

fail callback parameters

Property	Type	Description
`errorMsg`	string	Error message
`errorCode`	string \| number	Error code
		Error extension

Return Value

None

Examples

import { getFileSystemManager } from '@ray-js/ray'

// Create a directory first to ensure there's one to remove.
const fm = await getFileSystemManager();

fm.mkdir({
  dirPath: "thingfile://usr/ttt_demo_dir",
  recursive: true,
  success: () => {
    fm.rmdir({
      dirPath: "thingfile://usr/ttt_demo_dir",
      recursive: true,
      success: data => {
        console.log(data);
      },
      fail: error => {
        console.error(error);
      },
    });
  },
  fail: error => {
    console.error(error);
  },
});