Preparing search index...
The search index is not available
Webnative SDK
Webnative SDK
<internal>
Posix
Interface Posix
Hierarchy
Posix
Index
Methods
exists
get
ls
mkdir
mv
read
resolve
Symlink
rm
symlink
write
Methods
exists
exists
(
path
:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
)
:
Promise
<
boolean
>
Parameters
path:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
Returns
Promise
<
boolean
>
get
get
(
path
:
DistinctivePath
<
[
Partition
,
...
string
[]
]
>
)
:
Promise
<
null
|
PuttableUnixTree
|
File
>
Parameters
path:
DistinctivePath
<
[
Partition
,
...
string
[]
]
>
Returns
Promise
<
null
|
PuttableUnixTree
|
File
>
ls
ls
(
path
:
DirectoryPath
<
[
Partition
,
...
string
[]
]
>
)
:
Promise
<
Links
>
Parameters
path:
DirectoryPath
<
[
Partition
,
...
string
[]
]
>
Returns
Promise
<
Links
>
mkdir
mkdir
(
path
:
DirectoryPath
<
[
Partition
,
string
,
...
string
[]
]
>
, options
?:
MutationOptions
)
:
Promise
<
Posix
>
Parameters
path:
DirectoryPath
<
[
Partition
,
string
,
...
string
[]
]
>
Optional
options:
MutationOptions
Returns
Promise
<
Posix
>
mv
mv
(
from
:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
, to
:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
)
:
Promise
<
Posix
>
Parameters
from:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
to:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
Returns
Promise
<
Posix
>
read
read
(
path
:
FilePath
<
[
Partition
,
string
,
...
string
[]
]
>
)
:
Promise
<
null
|
Uint8Array
>
Parameters
path:
FilePath
<
[
Partition
,
string
,
...
string
[]
]
>
Returns
Promise
<
null
|
Uint8Array
>
resolve
Symlink
resolve
Symlink
(
link
:
SoftLink
)
:
Promise
<
null
|
File
|
Tree
>
Parameters
link:
SoftLink
Returns
Promise
<
null
|
File
|
Tree
>
rm
rm
(
path
:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
)
:
Promise
<
Posix
>
Parameters
path:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
Returns
Promise
<
Posix
>
symlink
symlink
(
args
:
{
at
:
DirectoryPath
<
[
Partition
,
string
,
...
string
[]
]
>
;
name
:
string
;
referringTo
:
{
path
:
Distinctive
<
[
Partition
,
...
string
[]
]
>
;
username
?:
string
;
}
;
}
)
:
Promise
<
Posix
>
Parameters
args:
{
at
:
DirectoryPath
<
[
Partition
,
string
,
...
string
[]
]
>
;
name
:
string
;
referringTo
:
{
path
:
Distinctive
<
[
Partition
,
...
string
[]
]
>
;
username
?:
string
;
}
;
}
at
:
DirectoryPath
<
[
Partition
,
string
,
...
string
[]
]
>
name
:
string
referring
To
:
{
path
:
Distinctive
<
[
Partition
,
...
string
[]
]
>
;
username
?:
string
;
}
path
:
Distinctive
<
[
Partition
,
...
string
[]
]
>
Optional
username
?:
string
Returns
Promise
<
Posix
>
write
write
(
path
:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
, content
:
Uint8Array
|
SoftLink
|
Record
<
string
,
SoftLink
>
|
SoftLink
[]
, options
?:
MutationOptions
)
:
Promise
<
Posix
>
Parameters
path:
DistinctivePath
<
[
Partition
,
string
,
...
string
[]
]
>
content:
Uint8Array
|
SoftLink
|
Record
<
string
,
SoftLink
>
|
SoftLink
[]
Optional
options:
MutationOptions
Returns
Promise
<
Posix
>
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
Modules
Webnative SDK
<internal>
Auth
Capabilities
Crypto
Depot
Manners
Reference
Storage
apps
did
fission
path
ucan
Posix
exists
get
ls
mkdir
mv
read
resolve
Symlink
rm
symlink
write
Generated using
TypeDoc