docs: update README.md

wmfs · Jan 4, 2019 · ed226c0 · ed226c0
1 parent b5f4bf4
commit ed226c0
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -19,12 +19,12 @@ const sp = new Sharepoint('URL HERE')
 
 sp.authenticate()
 sp.getWebEndpoint()
-sp.getContents(dirPath)
-sp.createFolder(options) // options = { dirPath, folderName }
-sp.deleteFolder(options) // options = { dirPath, folderName }
-sp.createFile(options) // options = { dirPath, fileName, data }
-sp.deleteFile(options) // options = { dirPath, fileName }
-sp.createFileChunked(options) // options = { dirPath, fileName, stream, fileSize, chunkSize }
+sp.getContents(patb)
+sp.createFolder(path)
+sp.deleteFolder(path)
+sp.createFile(options) // options = { path, fileName, data }
+sp.deleteFile(options) // options = { path, fileName }
+sp.createFileChunked(options) // options = { path, fileName, stream, fileSize, chunkSize }
 ```
 
 ## <a name="test"></a>Test

diff --git a/lib/index.js b/lib/index.js
@@ -77,14 +77,14 @@ class Sharepoint {
     return data.d.GetContextWebInformation.FormDigestValue
   }
 
-  async getContents (dirPath) {
+  async getContents (path) {
     this.checkHeaders()
 
     const { url, headers, site } = this
 
     const get = type => {
       return axios.get(
-        `${url}/_api/web/GetFolderByServerRelativeUrl('${site.serverRelativeUrl}${dirPath}')/${type}`,
+        `${url}/_api/web/GetFolderByServerRelativeUrl('${site.serverRelativeUrl}${path}')/${type}`,
         { headers, responseType: 'json' }
       )
     }
@@ -142,7 +142,7 @@ class Sharepoint {
     this.checkHeaders()
     const formDigestValue = await this.getFormDigestValue()
 
-    const { dirPath, fileName, data } = options
+    const { path, fileName, data } = options
 
     if (!fileName) {
       throw new Error('You must provide a file name.')
@@ -154,7 +154,7 @@ class Sharepoint {
 
     await axios({
       method: 'post',
-      url: `${this.url}/_api/web/GetFolderByServerRelativeUrl('${this.site.serverRelativeUrl}${dirPath}')/Files/add(url='${fileName}', overwrite=true)`,
+      url: `${this.url}/_api/web/GetFolderByServerRelativeUrl('${this.site.serverRelativeUrl}${path}')/Files/add(url='${fileName}', overwrite=true)`,
       data,
       headers: {
         ...this.headers,
@@ -165,15 +165,15 @@ class Sharepoint {
 
   async createFileChunked (options) {
     const {
-      dirPath, fileName, stream, fileSize
+      path, fileName, stream, fileSize
     } = options
 
     const chunkSize = options.chunkSize || 65536
     this.checkHeaders()
     const formDigestValue = await this.getFormDigestValue()
 
     await this.createFile({
-      dirPath,
+      path,
       fileName,
       data: ' '
     })
@@ -192,7 +192,7 @@ class Sharepoint {
             firstChunk = false
             const response = await axios({
               method: 'post',
-              url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/startupload(uploadId=guid'${uploadId}')`,
+              url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/startupload(uploadId=guid'${uploadId}')`,
               data,
               headers: {
                 ...self.headers,
@@ -203,7 +203,7 @@ class Sharepoint {
           } else if (sent + chunkSize >= fileSize) {
             await axios({
               method: 'post',
-              url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/finishupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
+              url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/finishupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
               data,
               headers: {
                 ...self.headers,
@@ -214,7 +214,7 @@ class Sharepoint {
           } else {
             const response = await axios({
               method: 'post',
-              url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/continueupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
+              url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/continueupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
               data,
               headers: {
                 ...self.headers,
@@ -228,7 +228,7 @@ class Sharepoint {
           stream.destroy()
           await axios({
             method: 'post',
-            url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
+            url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
             headers: {
               ...self.headers,
               'X-RequestDigest': formDigestValue
@@ -241,7 +241,7 @@ class Sharepoint {
       stream.on('error', async err => {
         await axios({
           method: 'post',
-          url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
+          url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
           headers: {
             ...self.headers,
             'X-RequestDigest': formDigestValue
@@ -258,15 +258,15 @@ class Sharepoint {
     this.checkHeaders()
     const formDigestValue = await this.getFormDigestValue()
 
-    const { dirPath, fileName } = options
+    const { path, fileName } = options
 
     if (!fileName) {
       throw new Error('You must provide a file name.')
     }
 
     await axios({
       method: 'post',
-      url: `${this.url}/_api/web/GetFileByServerRelativeUrl('${this.site.serverRelativeUrl}${dirPath}/${fileName}')`,
+      url: `${this.url}/_api/web/GetFileByServerRelativeUrl('${this.site.serverRelativeUrl}${path}/${fileName}')`,
       headers: {
         ...this.headers,
         'X-RequestDigest': formDigestValue,

diff --git a/test/test.js b/test/test.js
@@ -121,7 +121,7 @@ describe('Tests', function () {
 
     try {
       await sharepoint.createFile({
-        dirPath: process.env.SHAREPOINT_DIR_PATH,
+        path: process.env.SHAREPOINT_DIR_PATH,
         data: '...'
       })
     } catch (e) {
@@ -136,7 +136,7 @@ describe('Tests', function () {
 
     try {
       await sharepoint.createFile({
-        dirPath: process.env.SHAREPOINT_DIR_PATH,
+        path: process.env.SHAREPOINT_DIR_PATH,
         fileName: 'new file'
       })
     } catch (e) {
@@ -151,7 +151,7 @@ describe('Tests', function () {
 
     try {
       await sharepoint.deleteFile({
-        dirPath: process.env.SHAREPOINT_DIR_PATH
+        path: process.env.SHAREPOINT_DIR_PATH
       })
     } catch (e) {
       error = e.message
@@ -177,7 +177,7 @@ describe('Tests', function () {
 
   it('create file in new folder', async () => {
     await sharepoint.createFile({
-      dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
+      path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
       fileName: FILE_NAME,
       data: 'Testing 1 2 3...'
     })
@@ -191,7 +191,7 @@ describe('Tests', function () {
 
   it('delete the new file', async () => {
     await sharepoint.deleteFile({
-      dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
+      path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
       fileName: FILE_NAME
     })
   })
@@ -205,7 +205,7 @@ describe('Tests', function () {
     const data = getBinaryData(path.resolve(__dirname, 'fixtures', FILE_NAME))
 
     await sharepoint.createFile({
-      dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
+      path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
       fileName: FILE_NAME,
       data
     })
@@ -221,7 +221,7 @@ describe('Tests', function () {
     const data = getBinaryData(path.resolve(__dirname, 'fixtures', FILE_NAME_1))
 
     await sharepoint.createFile({
-      dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
+      path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
       fileName: FILE_NAME_1,
       data
     })
@@ -238,7 +238,7 @@ describe('Tests', function () {
     const { size } = fs.statSync(filePath)
     const stream = fs.createReadStream(filePath, { highWaterMark: 1024 * 2 })
     await sharepoint.createFileChunked({
-      dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
+      path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
       fileName: FILE_NAME_1,
       stream,
       fileSize: size,