This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
docs: clarify that mtime and mode are optional #3302
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This should minimize the number of people who pass those to ipfs.add when they don't really need them
achingbrain
reviewed
Sep 24, 2020
docs/core-api/FILES.md
Outdated
| @@ -180,7 +180,7 @@ An optional object which may have the following keys: | |||
| | -------- | -------- | | |||
| | `Promise<UnixFSEntry>` | A object describing the added data | | |||
|
|
|||
| Each yielded object is of the form: | |||
| Each yielded object is of the form (`mtime` and `mode` are optional, so may be missing): | |||
There was a problem hiding this comment.
mode has a default value so shouldn't be missing.
https://github.com/ipfs/specs/blob/master/UNIXFS.md#metadata
There was a problem hiding this comment.
@achingbrain Ack, I was unaware of implicit mode default.
This complicates things a bit.. would this work?
Suggested change
| Each yielded object is of the form (`mtime` and `mode` are optional, so may be missing): | |
| Each yielded object is of the form (with optional `mtime` and custom/implicit `mode` [metadata](https://github.com/ipfs/specs/blob/master/UNIXFS.md#metadata)): |
If not, we could just leave this line as it was before. Let me know.
There was a problem hiding this comment.
Perhaps reverting this and just adding a comment in the JS object below would be helpful? Additionally, keeping the optional ? indicator on the key is a nice way to represent the potential missing response value.
{
path: '/tmp/myfile.txt',
cid: CID('QmHash'),
mode: Number, // implicit if not provided
mtime?: { secs: Number, nsecs: Number }, // may be missing
size: 123
}
This was referenced Sep 21, 2022
This was referenced Nov 30, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should minimize the number of people who pass
mtimeandmodetoipfs.addwhen they don't really need them.Ref. https://discuss.ipfs.io/t/why-has-same-sub-cids-but-not-same-root-cid/8810/6?u=lidel