Socket
Socket
Sign inDemoInstall

@de-dan/capacitor-file-select

Package Overview
Dependencies
2
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@de-dan/capacitor-file-select

A Capacitor Plugin to select Files


Version published
Maintainers
1
0

Weekly downloads

Readme

Source

Capacitor File Select

Maintenance npm

👉🏼 Note: this Plugin is developed for Capacitor V4

This Plugin it used to select Files from the Device. Information about supported Extensions can be found here:

Donate

This and other Open-Source Cordova Plugins are developed in my free time. To help ensure this plugin is kept updated, new features are added and bugfixes are implemented quickly, please donate a couple of dollars (or a little more if you can stretch) as this will help me to afford to dedicate time to its maintenance. Please consider donating if you're using this plugin in an app that makes you money, if you're being paid to make the app, if you're asking for new features or priority bug fixes.

Install

npm install capacitor-file-select
npx cap sync

Changelog

The full Changelog is available here

API

select(...)

select(options: FileSelectOptions) => Promise<{ files?: FileSelectResult[]; webFiles?: FileList; }>

Opens the File Selector

ParamType
optionsFileSelectOptions

Returns: Promise<{ files?: FileSelectResult[]; webFiles?: any; }>


Interfaces

FileSelectResult
PropTypeDescription
pathstringFile Path
namestringFile Name
extensionstringFile Extensions
FileSelectOptions
PropTypeDescription
multiplebooleanSelect multiple Files
extensionsArray<string | FileType>Extensions to select
Array
PropTypeDescription
lengthnumberGets or sets the length of the array. This is a number one higher than the highest index in the array.
MethodSignatureDescription
toString() => stringReturns a string representation of an array.
toLocaleString() => stringReturns a string representation of an array. The elements are converted to string using their toLocalString methods.
pop() => T | undefinedRemoves the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
push(...items: T[]) => numberAppends new elements to the end of an array, and returns the new length of the array.
concat(...items: ConcatArray<T>[]) => T[]Combines two or more arrays. This method returns a new array without modifying any existing arrays.
concat(...items: (T | ConcatArray<T>)[]) => T[]Combines two or more arrays. This method returns a new array without modifying any existing arrays.
join(separator?: string | undefined) => stringAdds all the elements of an array into a string, separated by the specified separator string.
reverse() => T[]Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
shift() => T | undefinedRemoves the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
slice(start?: number | undefined, end?: number | undefined) => T[]Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
sort(compareFn?: ((a: T, b: T) => number) | undefined) => thisSorts an array in place. This method mutates the array and returns a reference to the same array.
splice(start: number, deleteCount?: number | undefined) => T[]Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice(start: number, deleteCount: number, ...items: T[]) => T[]Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
unshift(...items: T[]) => numberInserts new elements at the start of an array, and returns the new length of the array.
indexOf(searchElement: T, fromIndex?: number | undefined) => numberReturns the index of the first occurrence of a value in an array, or -1 if it is not present.
lastIndexOf(searchElement: T, fromIndex?: number | undefined) => numberReturns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
every<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]Determines whether all the members of an array satisfy the specified test.
every(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => booleanDetermines whether all the members of an array satisfy the specified test.
some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => booleanDetermines whether the specified callback function returns true for any element of an array.
forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => voidPerforms the specified action for each element in an array.
map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]Calls a defined callback function on each element of an array, and returns an array that contains the results.
filter<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]Returns the elements of an array that meet the condition specified in a callback function.
filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]Returns the elements of an array that meet the condition specified in a callback function.
reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => TCalls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => UCalls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => TCalls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => UCalls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
ConcatArray
PropType
lengthnumber
MethodSignature
join(separator?: string | undefined) => string
slice(start?: number | undefined, end?: number | undefined) => T[]

Enums

FileType
MembersValue
AUDIO'audios'
IMAGE'images'
VIDEO'videos'
EVERY'*'

Keywords

FAQs

Last updated on 23 Oct 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc