Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(core): improve Filesystem parameter descriptions #2023

Merged
merged 4 commits into from
Nov 13, 2019
Merged

fix(core): improve Filesystem parameter descriptions #2023

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05cf7e5
Change ReaddirOptions param description.
nip3o Nov 8, 2019
e8ba3f5
Use capital T.
nip3o Nov 8, 2019
470faf5
Updated StatOptions param descriptions.
nip3o Nov 8, 2019
485a445
switch the ReaddirOptions defs
jcesarmobile Nov 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions core/src/core-plugin-definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ export enum FilesystemEncoding {

export interface FileWriteOptions {
/**
* the filename to write
* The filename to write
*/
path: string;
/**
Expand All @@ -599,7 +599,7 @@ export interface FileWriteOptions {

export interface FileAppendOptions {
/**
* the filename to write
* The filename to write
*/
path: string;
/**
Expand All @@ -621,7 +621,7 @@ export interface FileAppendOptions {

export interface FileReadOptions {
/**
* the filename to read
* The filename to read
*/
path: string;
/**
Expand All @@ -639,7 +639,7 @@ export interface FileReadOptions {

export interface FileDeleteOptions {
/**
* the filename to delete
* The filename to delete
*/
path: string;
/**
Expand Down Expand Up @@ -688,11 +688,11 @@ export interface RmdirOptions {

export interface ReaddirOptions {
/**
* The path of the directory to remove
* The path of the directory to read
*/
path: string;
/**
* The FilesystemDirectory to remove the directory from
* The FilesystemDirectory to list files from
*/
directory?: FilesystemDirectory;
}
Expand All @@ -710,11 +710,11 @@ export interface GetUriOptions {

export interface StatOptions {
/**
* The path of the directory to remove
* The path of the file to get data about
*/
path: string;
/**
* The FilesystemDirectory to remove the directory from
* The FilesystemDirectory to get the file under
*/
directory?: FilesystemDirectory;
}
Expand Down