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.

Sign up for GitHub

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

Jump to bottom

writeable stream: group all properties #31187

Closed
wants to merge 1 commit into from
Closed

writeable stream: group all properties #31187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 61 additions & 94 deletions lib/_stream_writable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ const {
Boolean,
FunctionPrototype,
ObjectDefineProperty,
ObjectDefineProperties,
ObjectSetPrototypeOf,
Symbol,
SymbolHasInstance,
Expand Down Expand Up @@ -336,46 +337,6 @@ Writable.prototype.setDefaultEncoding = function setDefaultEncoding(encoding) {
return this;
};

ObjectDefineProperty(Writable.prototype, 'writableBuffer', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get: function() {
return this._writableState && this._writableState.getBuffer();
}
});

ObjectDefineProperty(Writable.prototype, 'writableEnded', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get: function() {
return this._writableState ? this._writableState.ending : false;
}
});

ObjectDefineProperty(Writable.prototype, 'writableHighWaterMark', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get: function() {
return this._writableState && this._writableState.highWaterMark;
}
});

ObjectDefineProperty(Writable.prototype, 'writableCorked', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get: function() {
return this._writableState ? this._writableState.corked : 0;
}
});

// If we're already writing something, then just put this
// in the queue, and wait our turn. Otherwise, call _write
// If we return false, then we need a drain event, so set that flag.
Expand Down Expand Up @@ -652,16 +613,6 @@ Writable.prototype.end = function(chunk, encoding, cb) {
return this;
};

ObjectDefineProperty(Writable.prototype, 'writableLength', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get() {
return this._writableState.length;
}
});

function needFinish(state) {
return (state.ending &&
state.length === 0 &&
Expand Down Expand Up @@ -774,59 +725,75 @@ function onFinished(stream, state, cb) {
stream.prependListener('error', onerror);
}

ObjectDefineProperty(Writable.prototype, 'writable', {
get() {
const w = this._writableState;
if (!w) return false;
if (w.writable !== undefined) return w.writable;
return Boolean(!w.destroyed && !w.errored && !w.ending);
ObjectDefineProperties(Writable.prototype, {

destroyed: {
get() {
return this._writableState ? this._writableState.destroyed : false;
},
set(value) {
// Backward compatibility, the user is explicitly managing destroyed
if (this._writableState) {
this._writableState.destroyed = value;
}
}
},

writable: {
get() {
const w = this._writableState;
if (!w) return false;
if (w.writable !== undefined) return w.writable;
return Boolean(!w.destroyed && !w.errored && !w.ending);
},
set(val) {
// Backwards compatible.
if (this._writableState) {
this._writableState.writable = !!val;
}
}
},
set(val) {
// Backwards compat.
if (this._writableState) {
this._writableState.writable = !!val;

writableFinished: {
get() {
return this._writableState ? this._writableState.finished : false;
}
}
});
},

ObjectDefineProperty(Writable.prototype, 'destroyed', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get() {
if (this._writableState === undefined) {
return false;
writableObjectMode: {
get() {
return this._writableState ? this._writableState.objectMode : false;
}
return this._writableState.destroyed;
},
set(value) {
// We ignore the value if the stream
// has not been initialized yet
if (!this._writableState) {
return;

writableBuffer: {
get() {
return this._writableState && this._writableState.getBuffer();
}
},

// Backward compatibility, the user is explicitly
// managing destroyed
this._writableState.destroyed = value;
}
});
writableEnded: {
get() {
return this._writableState ? this._writableState.ending : false;
}
},

ObjectDefineProperty(Writable.prototype, 'writableObjectMode', {
enumerable: false,
get() {
return this._writableState ? this._writableState.objectMode : false;
}
});
writableHighWaterMark: {
get() {
return this._writableState && this._writableState.highWaterMark;
}
},

ObjectDefineProperty(Writable.prototype, 'writableFinished', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get() {
return this._writableState ? this._writableState.finished : false;
writableCorked: {
get() {
return this._writableState ? this._writableState.corked : 0;
}
},

writableLength: {
get() {
return this._writableState && this._writableState.length;
}
}
});

Expand Down