doc: rename defaultEncoding option to encoding

[azasypkin]

The documentation for fs.createWriteStream() references a
defaultEncoding as possible options property, but in reality
encoding property is expected and properly handled. This fix updates
the documentation to rename the defaultEncoding property to
encoding.

Fixes: #14611

Checklist

• documentation is changed or added
• commit message follows commit guidelines

Affected core subsystem(s)

doc

[refack]

Refs:

node/lib/fs.js

Lines 2081 to 2082 in 2249234

	if (options.encoding)
	this.setDefaultEncoding(options.encoding);

node/lib/fs.js

Lines 79 to 80 in 2249234

	if (options.encoding !== 'buffer')
	assertEncoding(options.encoding);

[refack]

Welcome @azasypkin, and thank you for the contribution 🥇
What the CONTRIBUTION.md doesn't mention is that documentation changes can get tricky. While core changes can be auto-tested, doc changes need human validation. So don't be dismayed if this PR get allot of attention 😉

[lance]

@refack @lpinca looking at this I wondered why things still seem to work with options.defaultEncoding. It's because of this undocumented gem:

node/lib/_stream_writable.js

Line 99 in aa011a1

this.defaultEncoding = options.defaultEncoding || 'utf8';

When fs.createWritableStream() creates the new stream.Writable it's just passing along the user provided options.defaultEncoding (if there was one).

The Stream.Writable docs don't mention this as a possible option. So I guess this raises the question whether this also should be corrected. And maybe whether it should be left as-is for fs.createWritableStream.

_{refack: edited formatting to embed reffed line}

[refack]

The Stream.Writable docs don't mention this as a possible option. So I guess this raises the question whether this also should be corrected. And maybe whether it should be left as-is for fs.createWritableStream.

IMHO the docs for Stream.Writable should be updated as well (here, or in the separate PR is up to @azasypkin )
But IMHO the fs.createWritableStream docs should be changed since it leads to surprises - #14611

[refack]

/cc @nodejs/streams @nodejs/documentation

[azasypkin]

IMHO the docs for Stream.Writable should be updated as well (here, or in the separate PR is up to @azasypkin )

I think it makes sense to include this little change in this PR as well, I'll add it.

[mcollina]

@refack @azasypkin I would not add that change here. Ideally, I will remove defaultEncoding  from stream.Writable and stream.Readable completely, as they are concern of just crypto.

[mcollina]

LGTM

[azasypkin]

@refack @azasypkin I would not add that change here. Ideally, I will remove defaultEncoding from stream.Writable and stream.Readable completely, as they are concern of just crypto.

Okay, it's even better :)

[refack]

Landed in e96c11c

[refack]

@azasypkin congratulation on GitHub promoting you from:

to:

🍾
Hope to see you contribute again!

[azasypkin]

@azasypkin congratulation on GitHub promoting you from:

Yay, thanks!