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.

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

doc: Add missing documentation #336

Merged
merged 3 commits into from Apr 13, 2019
Merged

doc: Add missing documentation #336

merged 3 commits into from Apr 13, 2019

Conversation

zekth
Copy link
Contributor

@zekth zekth commented Apr 13, 2019

Added links to module documentation.
Added fs documentation.

Mention to @axetroy , could you provide an explanation for the options of writeJson module options please?

@axetroy
Copy link
Contributor

axetroy commented Apr 13, 2019

@zekth
The options is same with JSON.stringify(value[, replacer[, space]])

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters

/**
      * Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
      * @param value A JavaScript value, usually an object or array, to be converted.
      * @param replacer A function that transforms the results.
      * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
      */
    stringify(value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
    /**
      * Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
      * @param value A JavaScript value, usually an object or array, to be converted.
      * @param replacer An array of strings and numbers that acts as a approved list for selecting the object properties that will be stringified.
      * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
      */
    stringify(value: any, replacer?: (number | string)[] | null, space?: string | number): string;

fs/README.md Outdated Show resolved Hide resolved
fs/README.md Outdated Show resolved Hide resolved
Copy link
Member

@ry ry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thanks

I plan on doing some automated documentation at some point, but for the time being this is helpful.

@ry ry merged commit 4d25cc1 into denoland:master Apr 13, 2019
@zekth
Copy link
Contributor Author

zekth commented Apr 13, 2019

LGTM - thanks

I plan on doing some automated documentation at some point, but for the time being this is helpful.

Once denoland/deno#2089 will land i have a draft for TypeDoc autodocumentation.

@zekth zekth deleted the documentation branch April 13, 2019 20:16
ensureDirSync("./ensureDirSync"); // void
```

### ensure_file
Copy link
Contributor

@axetroy axetroy Apr 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here should be ensureFile

ry pushed a commit to ry/deno that referenced this pull request Oct 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants