breaking(types): type arrays as read-only (#1335)

Closes #1259

* breaking(types): type arrays as read-only

* Run "yarn build:docs"

* test: assert read-only arrays
This commit is contained in:
metonym 2022-06-05 13:25:43 -07:00 committed by GitHub
commit 260bf4e040
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
34 changed files with 257 additions and 192 deletions

View file

@ -7,13 +7,13 @@ export interface FileUploaderDropContainerProps
* Specify the accepted file types
* @default []
*/
accept?: string[];
accept?: ReadonlyArray<string>;
/**
* Obtain a reference to the uploaded files
* @default []
*/
files?: File[];
files?: ReadonlyArray<File>;
/**
* Set to `true` to allow multiple files
@ -22,11 +22,11 @@ export interface FileUploaderDropContainerProps
multiple?: boolean;
/**
* Override the default behavior of validating uploaded files
* The default behavior does not validate files
* Override the default behavior of validating uploaded files.
* By default, files are not validated
* @default (files) => files
*/
validateFiles?: (files: File[]) => File[];
validateFiles?: (files: ReadonlyArray<File>) => ReadonlyArray<File>;
/**
* Specify the label text
@ -74,8 +74,8 @@ export interface FileUploaderDropContainerProps
export default class FileUploaderDropContainer extends SvelteComponentTyped<
FileUploaderDropContainerProps,
{
add: CustomEvent<File[]>;
change: CustomEvent<File[]>;
add: CustomEvent<ReadonlyArray<File>>;
change: CustomEvent<ReadonlyArray<File>>;
dragover: WindowEventMap["dragover"];
dragleave: WindowEventMap["dragleave"];
drop: WindowEventMap["drop"];