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

stream: group all properties using defineProperties #31144

Closed
wants to merge 1 commit into from
Closed

stream: group all properties using defineProperties #31144

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
192 changes: 90 additions & 102 deletions lib/_stream_readable.js
View file
Open in desktop
Expand Up @@ -25,7 +25,7 @@ const {
ArrayIsArray,
NumberIsInteger,
NumberIsNaN,
ObjectDefineProperty,
ObjectDefineProperties,
ObjectSetPrototypeOf,
SymbolAsyncIterator,
Symbol
Expand Down Expand Up @@ -169,22 +169,6 @@ function ReadableState(options, stream, isDuplex) {
}
}

// Legacy getter for `pipesCount`
ObjectDefineProperty(ReadableState.prototype, 'pipesCount', {
get() {
return this.pipes.length;
}
});

// Legacy property for `paused`
ObjectDefineProperty(ReadableState.prototype, 'paused', {
get() {
return this[kPaused] !== false;
},
set(value) {
this[kPaused] = !!value;
}
});

function Readable(options) {
if (!(this instanceof Readable))
Expand All @@ -210,40 +194,6 @@ function Readable(options) {
Stream.call(this, options);
}

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

// Backward compatibility, the user is explicitly
// managing destroyed
this._readableState.destroyed = value;
}
});

ObjectDefineProperty(Readable.prototype, 'readableEnded', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get() {
return this._readableState ? this._readableState.endEmitted : false;
}
});

Readable.prototype.destroy = destroyImpl.destroy;
Readable.prototype._undestroy = destroyImpl.undestroy;
Readable.prototype._destroy = function(err, cb) {
Expand Down Expand Up @@ -1125,68 +1075,106 @@ Readable.prototype[SymbolAsyncIterator] = function() {
return createReadableStreamAsyncIterator(this);
};

ObjectDefineProperty(Readable.prototype, 'readableHighWaterMark', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get: function() {
return this._readableState.highWaterMark;
}
});
// Making it explicit these properties are not enumerable
// because otherwise some prototype manipulation in
// userland will fail
ObjectDefineProperties(Readable.prototype, {

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

ObjectDefineProperty(Readable.prototype, 'readableFlowing', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get: function() {
return this._readableState.flowing;
readableBuffer: {
enumerable: false,
get: function() {
return this._readableState && this._readableState.buffer;
}
},
set: function(state) {
if (this._readableState) {
this._readableState.flowing = state;

readableFlowing: {
enumerable: false,
get: function() {
return this._readableState.flowing;
},
set: function(state) {
if (this._readableState) {
this._readableState.flowing = state;
}
}
}
});
},

// Exposed for testing purposes only.
Readable._fromList = fromList;
readableLength: {
enumerable: false,
get() {
return this._readableState.length;
}
},

ObjectDefineProperty(Readable.prototype, 'readableLength', {
// Making it explicit this property is not enumerable
// because otherwise some prototype manipulation in
// userland will fail
enumerable: false,
get() {
return this._readableState.length;
}
});
readableObjectMode: {
enumerable: false,
get() {
return this._readableState ? this._readableState.objectMode : false;
}
},

ObjectDefineProperty(Readable.prototype, 'readableObjectMode', {
enumerable: false,
get() {
return this._readableState ? this._readableState.objectMode : false;
}
});
readableEncoding: {
enumerable: false,
get() {
return this._readableState ? this._readableState.encoding : null;
}
},

ObjectDefineProperty(Readable.prototype, 'readableEncoding', {
enumerable: false,
get() {
return this._readableState ? this._readableState.encoding : null;
destroyed: {
enumerable: false,
get() {
if (this._readableState === undefined) {
return false;
}
return this._readableState.destroyed;
},
set(value) {
// We ignore the value if the stream
// has not been initialized yet
if (!this._readableState) {
return;
}

// Backward compatibility, the user is explicitly
// managing destroyed
this._readableState.destroyed = value;
}
},

readableEnded: {
enumerable: false,
get() {
return this._readableState ? this._readableState.endEmitted : false;
}
},

// Legacy getter for `pipesCount`
pipesCount: {
get() {
return this.pipes.length;
}
},

paused: {
get() {
return this[kPaused] !== false;
},
set(value) {
this[kPaused] = !!value;
}
}
});

// Exposed for testing purposes only.
Readable._fromList = fromList;

// Pluck off n bytes from an array of buffers.
// Length is the combined lengths of all the buffers in the list.
// This function is designed to be inlinable, so please take care when making
Expand Down