Search
Preparing search index...
The search index is not available
@youwol/flux-files
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@youwol/flux-files
lib/implementation/local-drive
LocalDrive
Class LocalDrive
Hierarchy
Drive
LocalDrive
Index
Constructors
constructor
Properties
drive
events$
id
name
root
Folder
Handle
use
Cache
Methods
blob
create
File
create
Folder
delete
File
delete
Folder
get
File
get
File
OrFolder
Handle
get
Folder
list
Items
read
read
AsData
Url
read
AsJson
read
AsText
rename
Item
update
Content
Constructors
constructor
new
Local
Drive
(
id
:
string
, name
:
string
, rootFolderHandle
:
any
)
:
LocalDrive
Parameters
id:
string
name:
string
rootFolderHandle:
any
Returns
LocalDrive
Properties
Readonly
drive
drive
:
LocalDrive
= ...
Readonly
events$
events$
:
Subject
<
Event
>
= ...
Readonly
id
id
:
string
Readonly
name
name
:
string
Readonly
root
Folder
Handle
root
Folder
Handle
:
any
Readonly
use
Cache
use
Cache
:
boolean
= true
Methods
blob
blob
(
itemId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
File
>
Parameters
itemId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
File
>
create
File
create
File
(
folderId
:
string
, name
:
string
, content
:
Blob
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
LocalFile
>
Parameters
folderId:
string
name:
string
content:
Blob
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
LocalFile
>
create
Folder
create
Folder
(
parentFolderId
:
string
, name
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
LocalFolder
>
Parameters
parentFolderId:
string
name:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
LocalFolder
>
delete
File
delete
File
(
fileId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
any
>
Parameters
fileId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
any
>
delete
Folder
delete
Folder
(
folderId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
any
>
Parameters
folderId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
any
>
get
File
get
File
(
itemId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
LocalFile
>
Parameters
itemId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
LocalFile
>
get
File
OrFolder
Handle
get
File
OrFolder
Handle
(
itemId
:
any
)
:
Observable
<
any
>
Parameters
itemId:
any
Returns
Observable
<
any
>
get
Folder
get
Folder
(
itemId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
LocalFolder
>
Parameters
itemId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
LocalFolder
>
list
Items
list
Items
(
folderId
:
string
, maxResults
?:
number
, beginIterator
?:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
{
endIterator
:
string
;
files
:
LocalFile
[]
;
folders
:
LocalFolder
[]
}
>
Parameters
folderId:
string
maxResults:
number
= 100
beginIterator:
string
= ...
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
{
endIterator
:
string
;
files
:
LocalFile
[]
;
folders
:
LocalFolder
[]
}
>
read
read
(
fileId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
ArrayBuffer
>
Parameters
fileId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
ArrayBuffer
>
read
AsData
Url
read
AsData
Url
(
fileId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
string
>
Parameters
fileId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
string
>
read
AsJson
read
AsJson
(
fileId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
Json
>
Parameters
fileId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
Json
>
read
AsText
read
AsText
(
fileId
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
string
>
Parameters
fileId:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
string
>
rename
Item
rename
Item
(
item
:
LocalFile
|
LocalFolder
|
LocalDrive
, newName
:
string
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
LocalFile
>
Parameters
item:
LocalFile
|
LocalFolder
|
LocalDrive
newName:
string
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
LocalFile
>
update
Content
update
Content
(
fileId
:
string
, content
:
Blob
, events$
?:
Subject
<
Event
>
|
Subject
<
Event
>
[]
)
:
Observable
<
LocalFile
>
Parameters
fileId:
string
content:
Blob
Optional
events$:
Subject
<
Event
>
|
Subject
<
Event
>
[]
Returns
Observable
<
LocalFile
>
Exports
auto_
generated
lib/expectations
lib/explorer.module
lib/file-
picker.module
lib/implementation/interfaces
lib/implementation/local-
drive
lib/local-
drive.module
lib/main
lib/reader.module
Local
Drive
constructor
drive
events$
id
name
root
Folder
Handle
use
Cache
blob
create
File
create
Folder
delete
File
delete
Folder
get
File
get
File
OrFolder
Handle
get
Folder
list
Items
read
read
AsData
Url
read
AsJson
read
AsText
rename
Item
update
Content
Local
File
Local
Folder
Generated using
TypeDoc