Skip to content

Latest commit

 

History

History
205 lines (163 loc) · 6.71 KB

API.md

File metadata and controls

205 lines (163 loc) · 6.71 KB

Classes

OneDrive

Helper class that facilitates accessing one drive.

OneDriveAuth

Helper class that facilitates accessing one drive.

OneDriveMock

Mock OneDrive client that supports some of the operations the OneDrive class does.

SharePointSite

Helper class accessing folders and files using the SharePoint V1 API.

Constants

globalTenantCache : Map.<string, string>

map that caches the tenant ids

Functions

handleNamedItems(sheet, segs, method, body) ⇒ object

Handle the namedItems operation on a workbook / worksheet

handleTable(sheet, segs, method, body) ⇒ object

Handle the table operation on a workbook / worksheet

splitByExtension(name) ⇒ Array.<string>

Splits the given name at the last '.', returning the extension and the base name.

sanitizeName(name) ⇒ string

Sanitizes the given string by :

  • convert to lower case
  • normalize all unicode characters
  • replace all non-alphanumeric characters with a dash
  • remove all consecutive dashes
  • remove all leading and trailing dashes
sanitizePath(filepath, opts) ⇒ string

Sanitizes the file path by:

  • convert to lower case
  • normalize all unicode characters
  • replace all non-alphanumeric characters with a dash
  • remove all consecutive dashes
  • remove all leading and trailing dashes

Note that only the basename of the file path is sanitized. i.e. The ancestor path and the extension is not affected.

editDistance(s0, s1) ⇒ number | *

Compute the edit distance using a recursive algorithm. since we only expect to have relative short filenames, the algorithm shouldn't be too expensive.

superTrim(str) ⇒ string

Trims the string at both ends and removes the zero width unicode chars:

  • U+200B zero width space
  • U+200C zero width non-joiner Unicode code point
  • U+200D zero width joiner Unicode code point
  • U+FEFF zero width no-break space Unicode code point

Typedefs

AuthenticationResult : module:@azure/msal-node~AuthenticationResult

aliases

globalTenantCache : Map.<string, string>

map that caches the tenant ids

Kind: global constant

handleNamedItems(sheet, segs, method, body) ⇒ object

Handle the namedItems operation on a workbook / worksheet

Kind: global function
Returns: object - The response value

Param Type Description
sheet object The mock data
segs Array.<string> Array of path segments
method string Request method
body object Request body

handleTable(sheet, segs, method, body) ⇒ object

Handle the table operation on a workbook / worksheet

Kind: global function
Returns: object - The response value

Param Type Description
sheet object The mock data
segs Array.<string> Array of path segments
method string Request method
body object Request body

splitByExtension(name) ⇒ Array.<string>

Splits the given name at the last '.', returning the extension and the base name.

Kind: global function
Returns: Array.<string> - Returns an array containing the base name and extension.

Param Type Description
name string Filename

sanitizeName(name) ⇒ string

Sanitizes the given string by :

  • convert to lower case
  • normalize all unicode characters
  • replace all non-alphanumeric characters with a dash
  • remove all consecutive dashes
  • remove all leading and trailing dashes

Kind: global function
Returns: string - sanitized name

Param Type
name string

sanitizePath(filepath, opts) ⇒ string

Sanitizes the file path by:

  • convert to lower case
  • normalize all unicode characters
  • replace all non-alphanumeric characters with a dash
  • remove all consecutive dashes
  • remove all leading and trailing dashes

Note that only the basename of the file path is sanitized. i.e. The ancestor path and the extension is not affected.

Kind: global function
Returns: string - sanitized file path

Param Type Description
filepath string the file path
opts object Options
[opts.ignoreExtension] boolean if {@code true} ignores the extension

editDistance(s0, s1) ⇒ number | *

Compute the edit distance using a recursive algorithm. since we only expect to have relative short filenames, the algorithm shouldn't be too expensive.

Kind: global function

Param Type Description
s0 string Input string
s1 string Input string

superTrim(str) ⇒ string

Trims the string at both ends and removes the zero width unicode chars:

  • U+200B zero width space
  • U+200C zero width non-joiner Unicode code point
  • U+200D zero width joiner Unicode code point
  • U+FEFF zero width no-break space Unicode code point

Kind: global function
Returns: string - trimmed and stripped string

Param Type Description
str string input string

AuthenticationResult : module:@azure/msal-node~AuthenticationResult

aliases

Kind: global typedef