Skip to content

Commit

Permalink
buffer: docs-only deprecate SlowBuffer
Browse files Browse the repository at this point in the history
With the addition of `Buffer.allocUnsafeSlow(size)`
`SlowBuffer` can be deprecated... but docs-only for now.

PR-URL: #5833
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
  • Loading branch information
jasnell committed Apr 26, 2016
1 parent d0c6e6f commit 829d613
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/api/buffer.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -1783,6 +1783,9 @@ Note that this is a property on the `buffer` module as returned by

## Class: SlowBuffer

Stability: 0 - Deprecated: Use
[`Buffer.allocUnsafeSlow(size)`][buffer_allocunsafeslow] instead.

Returns an un-pooled `Buffer`.

In order to avoid the garbage collection overhead of creating many individually
Expand Down Expand Up @@ -1813,6 +1816,9 @@ has observed undue memory retention in their applications.

### new SlowBuffer(size)

Stability: 0 - Deprecated: Use
[`Buffer.allocUnsafeSlow(size)`][buffer_allocunsafeslow] instead.

* `size` Number

Allocates a new `SlowBuffer` of `size` bytes. The `size` must be less than
Expand Down

0 comments on commit 829d613

Please sign in to comment.