{"id":21655908,"url":"https://github.com/koltyakov/pnp-upload","last_synced_at":"2025-10-16T20:37:02.261Z","repository":{"id":35735784,"uuid":"149258530","full_name":"koltyakov/pnp-upload","owner":"koltyakov","description":"SharePoint: Large files upload example using PnPjs from Node.js","archived":false,"fork":false,"pushed_at":"2022-12-08T01:16:17.000Z","size":692,"stargazers_count":13,"open_issues_count":9,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-08T09:25:29.677Z","etag":null,"topics":["example","nodejs","pnpjs","sharepoint","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koltyakov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-18T09:00:02.000Z","updated_at":"2024-01-09T09:56:38.000Z","dependencies_parsed_at":"2023-01-16T04:36:24.702Z","dependency_job_id":null,"html_url":"https://github.com/koltyakov/pnp-upload","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koltyakov%2Fpnp-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koltyakov%2Fpnp-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koltyakov%2Fpnp-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koltyakov%2Fpnp-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koltyakov","download_url":"https://codeload.github.com/koltyakov/pnp-upload/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248482886,"owners_count":21111400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["example","nodejs","pnpjs","sharepoint","typescript"],"created_at":"2024-11-25T08:37:45.532Z","updated_at":"2025-10-16T20:36:57.229Z","avatar_url":"https://github.com/koltyakov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://koltyakov.visualstudio.com/SPNode/_apis/build/status/pnp-upload?branchName=master)](https://koltyakov.visualstudio.com/SPNode/_build/latest?definitionId=16\u0026branchName=master)\r\n\r\n# SharePoint: Large files upload example using PnPjs from Node.js\r\n\r\n## Supported SharePoint versions\r\n\r\n- SharePoint Online\r\n- SharePoint On-Prem (2019/2016)\r\n\r\n## Dependencies\r\n\r\n```bash\r\nnpm install\r\n```\r\n## Test\r\n\r\nReplace `./test/ReplaceWithLargeOne.avi` with a large file to upload to SharePoint.\r\n\r\nIn a console, run the following command:\r\n\r\n```bash\r\nnpm run test\r\n```\r\n\r\nProvide SharePoint credentials during first execution.\r\n\r\n![upload](./assets/upload.png)\r\n\r\n## Upload method\r\n\r\nPnPjs's `.addChunked` API implementation is used for uploading a large document in chunks.\r\n\r\n## Authentication\r\n\r\nA variety of different authentication strategies are covered using `node-sp-auth` library.\r\n\r\n`pnp-auth` Node.js fetch client is used to proxy all available auth strategies.\r\n\r\n## Usage sample\r\n\r\n```typescript\r\nconst filePath = './file-path.ext';\r\nconst folderUrl = 'Shared Documents';\r\n// context - authentication context, see `./test/upload.test.ts` for more details\r\n\r\nconst upload = new Upload(context);\r\nconst folderRelativeUrl = `/${context.siteUrl.split('/').slice(3).join('/')}/${folderUrl}`;\r\n\r\nlet progress: ProgressBar = null;\r\nupload\r\n  .addChunked(folderRelativeUrl, filePath, (data) =\u003e {\r\n    if (!progress) {\r\n      progress = new ProgressBar(`Uploading ${filePath} [:bar] ${data.fileSize} B`, { total: data.totalBlocks });\r\n    }\r\n    progress.tick();\r\n  })\r\n  .then(() =\u003e console.log('Done'))\r\n  .catch(console.warn);\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoltyakov%2Fpnp-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoltyakov%2Fpnp-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoltyakov%2Fpnp-upload/lists"}