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

Conversation

3 participants
@zekth
Copy link
Contributor

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

This comment has been minimized.

Copy link
Contributor

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;
Show resolved Hide resolved fs/README.md Outdated
Show resolved Hide resolved fs/README.md Outdated

zekth added some commits Apr 13, 2019

@ry
Copy link
Contributor

left a comment

LGTM - thanks

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

@ry

ry approved these changes Apr 13, 2019

@ry ry merged commit 4d25cc1 into denoland:master Apr 13, 2019

2 checks passed

denoland.deno_std #20190413.5 succeeded
Details
license/cla Contributor License Agreement is signed.
Details
@zekth

This comment has been minimized.

Copy link
Contributor Author

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 zekth:documentation branch Apr 13, 2019

ensureDirSync("./ensureDirSync"); // void
```

### ensure_file

This comment has been minimized.

Copy link
@axetroy

axetroy Apr 14, 2019

Contributor

here should be ensureFile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.