From 2d5453b85d9e7f120100f672d41f73f4616f522e Mon Sep 17 00:00:00 2001 From: Ethan Brown Date: Tue, 6 Aug 2024 16:36:10 -0700 Subject: [PATCH] fix(docs): StorageManager prop corrections --- CONTRIBUTING.md | 4 ++-- .../connected-components/storage/storagemanager/props.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5224fdd2228..b18c8ebae36 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,8 +42,8 @@ You should open an issue to discuss your pull request, unless it's a trivial cha 1. Fork & Clone this repo (Make sure to disable associated GitHub Actions. In fork go to Settings > Actions > General > Disable actions > save) 1. [`nvm install`](https://github.com/nvm-sh/nvm) -1. [`nvm use`](https://github.com/nvm-sh/nvm) -1. `yarn setup` +1. [`nvm use`](https://github.com/nvm-sh/nvm) (uses `.nvmrc` to use supported Node version) +1. `yarn setup` (note: this includes `yarn install`) 1. Within your fork, create a new branch based on the issue you're addressing, e.g. `git checkout -b angular/remove-browser-module` 1. Commit your code using [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/#summary), e.g. `git commit -m "chore: remove browser module"`. 1. Once your work is committed, validate your changes according to [local development guides](#local-development-guides). diff --git a/docs/src/pages/[platform]/connected-components/storage/storagemanager/props.ts b/docs/src/pages/[platform]/connected-components/storage/storagemanager/props.ts index e516ee4b560..95ef81facbb 100644 --- a/docs/src/pages/[platform]/connected-components/storage/storagemanager/props.ts +++ b/docs/src/pages/[platform]/connected-components/storage/storagemanager/props.ts @@ -83,7 +83,7 @@ export const STORAGE_MANAGER = [ name: `processFile?`, description: 'Called immediately before uploading a file to allow you to edit the key or the file itself. The function can return synchronously or return a promise.', - type: `(params: {key: string, file: Blob}) => Promise<{key: string, file: Blob} & Record> | {key: string, file: Blob} & Record;`, + type: `(params: {key: string, file: File}) => Promise<{key: string, file: File} & Record> | {key: string, file: File} & Record;`, }, { name: `defaultFiles?`,