removeFolder

Function
import { removeFolder } from "@esri/arcgis-rest-portal";
//
removeFolder({
  folderId: "fe4",
  owner: "c@sey",
  authentication
})
  .then(response)
Delete a non-root folder and all the items it contains. See the [REST
Documentation](https://developers.arcgis.com/rest/users-groups-and-items/delete-folder.htm) for
more information.
  • removeFolder(requestOptions: IFolderIdOptions) : Promise<{
    folder:
    {
    id:
    string
    title:
    string
    username:
    string
    }
    success:
    boolean
    }>

Parameters

Parameter Type Default Notes
requestOptions Required IFolderIdOptions

Options for the request

Available requestOptions

Property Type Notes
folderId string

Unique identifier of the folder.

authentication Inherited UserSession

A session representing a logged in user.

owner Optional string

Item owner username. If not present, authentication.username is utilized.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

A Promise that deletes a folder

Promise<{
folder:
{
id:
string
title:
string
username:
string
}
success:
boolean
}>

Function defined in packages/arcgis-rest-portal/src/items/remove.ts:114