Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 33aa632

Browse files
lidelachingbrain
andauthoredOct 27, 2020
docs: clarify that mtime and mode are optional (#3302)
Co-authored-by: achingbrain <alex@achingbrain.net>
1 parent 5cc6dfe commit 33aa632

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed
 

‎docs/core-api/FILES.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@ If no `content` is passed, then the item is treated as an empty directory.
138138

139139
One of `path` or `content` _must_ be passed.
140140

141+
Both `mode` and `mtime` are optional and will result in different [CID][]s for the same file if passed.
142+
143+
`mode` will have a default value applied if not set, see [UnixFS Metadata](https://github.com/ipfs/specs/blob/master/UNIXFS.md#metadata) for further discussion.
144+
141145
##### FileContent
142146

143147
`FileContent` is one of the following types:
@@ -186,8 +190,8 @@ Each yielded object is of the form:
186190
{
187191
path: '/tmp/myfile.txt',
188192
cid: CID('QmHash'),
189-
mode: Number,
190-
mtime: { secs: Number, nsecs: Number },
193+
mode: Number, // implicit if not provided - 0644 for files, 0755 for directories
194+
mtime?: { secs: Number, nsecs: Number },
191195
size: 123
192196
}
193197
```
@@ -268,8 +272,8 @@ Each yielded object is of the form:
268272
{
269273
path: '/tmp/myfile.txt',
270274
cid: CID('QmHash'),
271-
mode: Number,
272-
mtime: { secs: Number, nsecs: Number },
275+
mode: Number, // implicit if not provided - 0644 for files, 0755 for directories
276+
mtime?: { secs: Number, nsecs: Number },
273277
size: 123
274278
}
275279
```
@@ -458,8 +462,8 @@ Each yielded object is of the form:
458462
{
459463
path: string,
460464
content: <AsyncIterable<Uint8Array>>,
461-
mode: number,
462-
mtime: { secs: number, nsecs: number }
465+
mode: Number, // implicit if not provided - 0644 for files, 0755 for directories
466+
mtime?: { secs: Number, nsecs: Number }
463467
}
464468
```
465469

@@ -522,8 +526,8 @@ Each yielded object is of the form:
522526
size: 11696,
523527
cid: CID('QmZyUEQVuRK3XV7L9Dk26pg6RVSgaYkiSTEdnT2kZZdwoi'),
524528
type: 'file',
525-
mode: Number,
526-
mtime: { secs: Number, nsecs: Number }
529+
mode: Number, // implicit if not provided - 0644 for files, 0755 for directories
530+
mtime?: { secs: Number, nsecs: Number }
527531
}
528532
```
529533

0 commit comments

Comments
 (0)
This repository has been archived.