Skip to content

Commit ed226c0

Browse files
meenahodameenahoda
committed
docs: update README.md
1 parent b5f4bf4 commit ed226c0

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

‎README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ const sp = new Sharepoint('URL HERE')
1919
2020
sp.authenticate()
2121
sp.getWebEndpoint()
22-
sp.getContents(dirPath)
23-
sp.createFolder(options) // options = { dirPath, folderName }
24-
sp.deleteFolder(options) // options = { dirPath, folderName }
25-
sp.createFile(options) // options = { dirPath, fileName, data }
26-
sp.deleteFile(options) // options = { dirPath, fileName }
27-
sp.createFileChunked(options) // options = { dirPath, fileName, stream, fileSize, chunkSize }
22+
sp.getContents(patb)
23+
sp.createFolder(path)
24+
sp.deleteFolder(path)
25+
sp.createFile(options) // options = { path, fileName, data }
26+
sp.deleteFile(options) // options = { path, fileName }
27+
sp.createFileChunked(options) // options = { path, fileName, stream, fileSize, chunkSize }
2828
```
2929

3030
## <a name="test"></a>Test

‎lib/index.js

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ class Sharepoint {
7777
return data.d.GetContextWebInformation.FormDigestValue
7878
}
7979

80-
async getContents (dirPath) {
80+
async getContents (path) {
8181
this.checkHeaders()
8282

8383
const { url, headers, site } = this
8484

8585
const get = type => {
8686
return axios.get(
87-
`${url}/_api/web/GetFolderByServerRelativeUrl('${site.serverRelativeUrl}${dirPath}')/${type}`,
87+
`${url}/_api/web/GetFolderByServerRelativeUrl('${site.serverRelativeUrl}${path}')/${type}`,
8888
{ headers, responseType: 'json' }
8989
)
9090
}
@@ -142,7 +142,7 @@ class Sharepoint {
142142
this.checkHeaders()
143143
const formDigestValue = await this.getFormDigestValue()
144144

145-
const { dirPath, fileName, data } = options
145+
const { path, fileName, data } = options
146146

147147
if (!fileName) {
148148
throw new Error('You must provide a file name.')
@@ -154,7 +154,7 @@ class Sharepoint {
154154

155155
await axios({
156156
method: 'post',
157-
url: `${this.url}/_api/web/GetFolderByServerRelativeUrl('${this.site.serverRelativeUrl}${dirPath}')/Files/add(url='${fileName}', overwrite=true)`,
157+
url: `${this.url}/_api/web/GetFolderByServerRelativeUrl('${this.site.serverRelativeUrl}${path}')/Files/add(url='${fileName}', overwrite=true)`,
158158
data,
159159
headers: {
160160
...this.headers,
@@ -165,15 +165,15 @@ class Sharepoint {
165165

166166
async createFileChunked (options) {
167167
const {
168-
dirPath, fileName, stream, fileSize
168+
path, fileName, stream, fileSize
169169
} = options
170170

171171
const chunkSize = options.chunkSize || 65536
172172
this.checkHeaders()
173173
const formDigestValue = await this.getFormDigestValue()
174174

175175
await this.createFile({
176-
dirPath,
176+
path,
177177
fileName,
178178
data: ' '
179179
})
@@ -192,7 +192,7 @@ class Sharepoint {
192192
firstChunk = false
193193
const response = await axios({
194194
method: 'post',
195-
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/startupload(uploadId=guid'${uploadId}')`,
195+
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/startupload(uploadId=guid'${uploadId}')`,
196196
data,
197197
headers: {
198198
...self.headers,
@@ -203,7 +203,7 @@ class Sharepoint {
203203
} else if (sent + chunkSize >= fileSize) {
204204
await axios({
205205
method: 'post',
206-
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/finishupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
206+
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/finishupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
207207
data,
208208
headers: {
209209
...self.headers,
@@ -214,7 +214,7 @@ class Sharepoint {
214214
} else {
215215
const response = await axios({
216216
method: 'post',
217-
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/continueupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
217+
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/continueupload(uploadId=guid'${uploadId}',fileoffset=${sent})`,
218218
data,
219219
headers: {
220220
...self.headers,
@@ -228,7 +228,7 @@ class Sharepoint {
228228
stream.destroy()
229229
await axios({
230230
method: 'post',
231-
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
231+
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
232232
headers: {
233233
...self.headers,
234234
'X-RequestDigest': formDigestValue
@@ -241,7 +241,7 @@ class Sharepoint {
241241
stream.on('error', async err => {
242242
await axios({
243243
method: 'post',
244-
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${dirPath}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
244+
url: `${self.url}/_api/web/getfilebyserverrelativeurl('${self.site.serverRelativeUrl}${path}/${fileName}')/cancelupload(uploadId=guid'${uploadId}')`,
245245
headers: {
246246
...self.headers,
247247
'X-RequestDigest': formDigestValue
@@ -258,15 +258,15 @@ class Sharepoint {
258258
this.checkHeaders()
259259
const formDigestValue = await this.getFormDigestValue()
260260

261-
const { dirPath, fileName } = options
261+
const { path, fileName } = options
262262

263263
if (!fileName) {
264264
throw new Error('You must provide a file name.')
265265
}
266266

267267
await axios({
268268
method: 'post',
269-
url: `${this.url}/_api/web/GetFileByServerRelativeUrl('${this.site.serverRelativeUrl}${dirPath}/${fileName}')`,
269+
url: `${this.url}/_api/web/GetFileByServerRelativeUrl('${this.site.serverRelativeUrl}${path}/${fileName}')`,
270270
headers: {
271271
...this.headers,
272272
'X-RequestDigest': formDigestValue,

‎test/test.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ describe('Tests', function () {
121121

122122
try {
123123
await sharepoint.createFile({
124-
dirPath: process.env.SHAREPOINT_DIR_PATH,
124+
path: process.env.SHAREPOINT_DIR_PATH,
125125
data: '...'
126126
})
127127
} catch (e) {
@@ -136,7 +136,7 @@ describe('Tests', function () {
136136

137137
try {
138138
await sharepoint.createFile({
139-
dirPath: process.env.SHAREPOINT_DIR_PATH,
139+
path: process.env.SHAREPOINT_DIR_PATH,
140140
fileName: 'new file'
141141
})
142142
} catch (e) {
@@ -151,7 +151,7 @@ describe('Tests', function () {
151151

152152
try {
153153
await sharepoint.deleteFile({
154-
dirPath: process.env.SHAREPOINT_DIR_PATH
154+
path: process.env.SHAREPOINT_DIR_PATH
155155
})
156156
} catch (e) {
157157
error = e.message
@@ -177,7 +177,7 @@ describe('Tests', function () {
177177

178178
it('create file in new folder', async () => {
179179
await sharepoint.createFile({
180-
dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
180+
path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
181181
fileName: FILE_NAME,
182182
data: 'Testing 1 2 3...'
183183
})
@@ -191,7 +191,7 @@ describe('Tests', function () {
191191

192192
it('delete the new file', async () => {
193193
await sharepoint.deleteFile({
194-
dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
194+
path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
195195
fileName: FILE_NAME
196196
})
197197
})
@@ -205,7 +205,7 @@ describe('Tests', function () {
205205
const data = getBinaryData(path.resolve(__dirname, 'fixtures', FILE_NAME))
206206

207207
await sharepoint.createFile({
208-
dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
208+
path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
209209
fileName: FILE_NAME,
210210
data
211211
})
@@ -221,7 +221,7 @@ describe('Tests', function () {
221221
const data = getBinaryData(path.resolve(__dirname, 'fixtures', FILE_NAME_1))
222222

223223
await sharepoint.createFile({
224-
dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
224+
path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
225225
fileName: FILE_NAME_1,
226226
data
227227
})
@@ -238,7 +238,7 @@ describe('Tests', function () {
238238
const { size } = fs.statSync(filePath)
239239
const stream = fs.createReadStream(filePath, { highWaterMark: 1024 * 2 })
240240
await sharepoint.createFileChunked({
241-
dirPath: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
241+
path: `${process.env.SHAREPOINT_DIR_PATH}/${FOLDER_NAME}`,
242242
fileName: FILE_NAME_1,
243243
stream,
244244
fileSize: size,

0 commit comments

Comments
 (0)