Skip to main content
Version: 2.1.2

propfind

propfind

The PROPFIND method retrieves properties defined on the resource identified by the Request-URI

const [result] = await propfind({
url: 'https://caldav.icloud.com/',
props: [{ name: 'current-user-principal', namespace: DAVNamespace.DAV }],
headers: {
authorization: 'Basic x0C9uFWd9Vz8OwS0DEAtkAlj',
},
});

Arguments

  • url required, request url
  • props required, ElementCompact props to find
  • depth DAVDepth
  • headers request headers
  • headersToExclude array of keys of the headers you want to exclude
  • fetchOptions options to pass to underlying fetch function

Return Value

array of DAVResponse

Behavior

send a prop find request, parse the response xml to an array of DAVResponse.