Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

README: remove docs and add link to real API docs

  • Loading branch information...
commit de2315cde3d84d0f0059f1168d1c6eb0f02e52eb 1 parent b6c99af
@TooTallNate authored
Showing with 5 additions and 219 deletions.
  1. +5 −219 README.md
View
224 README.md
@@ -62,223 +62,7 @@ var one = buf.ref()
console.log(one.deref().deref()) // ← 12345
```
-
-Additions to `Buffer.prototype`
--------------------------------
-
-`ref` extends Node's core `Buffer` instances with some useful additions:
-
----
-
-#### `Buffer#address()` → Number
-
-Returns the memory address of the Buffer instance.
-
----
-
-#### `Buffer#isNull()` → Boolean
-
-Returns `true` if the Buffer's memory address is NULL, `false` otherwise.
-
----
-
-#### `Buffer#ref()` → Buffer
-
-Returns a new Buffer instance that is referencing this Buffer. That is, the new
-Buffer is "pointer" sized, and points to the memory address of this Buffer.
-
-The returned Buffer's `type` property gets set properly as well, with an
-`indirection` level increased by 1.
-
----
-
-#### `Buffer#deref()` → ???
-
-Returns the dereferenced value from the Buffer instance. This depends on the
-`type` property being set to a proper "type" instance (see below).
-
-The returned value can be another Buffer, or pretty much be anything else,
-depending on the `get()` function of the "type" instance and current
-`indirection` level of the Buffer.
-
----
-
-#### `Buffer#readObject(Number offset)` → Object
-
-Returns the JS `Object` that has previously been written to the Buffer at the
-given offset using `writeObject()`.
-
----
-
-#### `Buffer#writeObject(Object obj, Number offset)` → undefined
-
-Writes the given JS `Object` to the Buffer at the given offset. Make sure that at
-least `ref.sizeof.Object` bytes are available in the Buffer after the specified
-offset. The object can later be retrieved using `readObject()`.
-
-`obj` gets "attached" to the buffer instance, so that the written object won't
-be garbage collected until the target buffer does.
-
----
-
-#### `Buffer#readPointer(Number offset, Number size)` → Buffer
-
-Returns a new Buffer instance pointing to the address specified in this Buffer at
-the given offset. The `size` is the length of the returned Buffer, which defaults
-to 0.
-
----
-
-#### `Buffer#writePointer(Buffer pointer, Number offset)` → undefined
-
-Writes the given Buffer's memory address to this Buffer at the given offset. Make
-sure that at least `ref.sizeof.pointer` bytes are available in the Buffer after
-the specified offset. The Buffer can later be retrieved again using
-`readPointer()`.
-
-`pointer` gets "attached" to the buffer instance, so that the written pointer
-won't be garbage collected until the target buffer does.
-
----
-
-#### `Buffer#readCString(Number offset)` → String
-
-Returns a JS String from read from the Buffer at the given offset. The C String is
-read up til the first NULL byte, which indicates the end of the C String.
-
-This function can read beyond the length of a Buffer, and reads up until the first
-NULL byte regardless.
-
----
-
-#### `Buffer#writeCString(String string, Number offset, String encoding)` → undefined
-
-Writes `string` as a C String (i.e. NULL terminated) to this Buffer at the given
-offset. `encoding` is optional and defaults to `utf8`.
-
----
-
-#### `Buffer#readInt64LE(Number offset)` → Number|String
-
-Returns a Number or String representation of the 64-bit int read from this Buffer
-at the given offset. If the returned value will fit inside a Number without losing
-precision, then a Number is returned, otherwise a String is returned.
-
----
-
-#### `Buffer#writeInt64LE(Number|String value, Number offset)` → undefined
-
-Writes an value as a `int64_t` to this Buffer at the given offset. `value` may be
-either a Number or a String representing the 64-bit int value. Ensure that at
-least `ref.sizeof.int64` (always 8) bytes are available in the Buffer after the
-given offset.
-
----
-
-#### `Buffer#readUInt64LE(Number offset)` → Number|String
-
-Returns a Number or String representation of the 64-bit unsigned int read from
-this Buffer at the given offset. If the returned value will fit inside a
-Number without losing precision, then a Number is returned, otherwise a String
-is returned.
-
----
-
-#### `Buffer#writeUInt64LE(Number|String value, Number offset)` → undefined
-
-Writes an value as a `int64_t` to this Buffer at the given offset. `value` may be
-either a Number or a String representing the 64-bit unsigned int value. Ensure
-that at least `ref.sizeof.uint64` (always 8) bytes are available in the Buffer
-after the given offset.
-
----
-
-#### `Buffer#readInt64BE(Number offset)` → Number|String
-
-Returns a Number or String representation of the 64-bit int read from this Buffer
-at the given offset. If the returned value will fit inside a Number without losing
-precision, then a Number is returned, otherwise a String is returned.
-
----
-
-#### `Buffer#writeInt64BE(Number|String value, Number offset)` → undefined
-
-Writes an value as a `int64_t` to this Buffer at the given offset. `value` may be
-either a Number or a String representing the 64-bit int value. Ensure that at
-least `ref.sizeof.int64` (always 8) bytes are available in the Buffer after the
-given offset.
-
----
-
-#### `Buffer#readUInt64BE(Number offset)` → Number|String
-
-Returns a Number or String representation of the 64-bit unsigned int read from
-this Buffer at the given offset. If the returned value will fit inside a
-Number without losing precision, then a Number is returned, otherwise a String
-is returned.
-
----
-
-#### `Buffer#writeUInt64BE(Number|String value, Number offset)` → undefined
-
-Writes an value as a `int64_t` to this Buffer at the given offset. `value` may be
-either a Number or a String representing the 64-bit unsigned int value. Ensure
-that at least `ref.sizeof.uint64` (always 8) bytes are available in the Buffer
-after the given offset.
-
----
-
-#### `Buffer#reinterpret(Number size)` → Buffer
-
-Returns a new Buffer instance with the exact same memory address as the target
-buffer, only you can specifiy the size of the returned buffer as well.
-
-The original buffer instance gets "attached" to the new buffer instance, so that
-the original buffer won't be garbage collected until the new buffer does.
-
-__Warning:__ This function is potentially _dangerous_! There are only a small few
-use-cases where it _really_ needs to be used (i.e. resizing a Buffer returned from
-an FFI'd `malloc()` call), but otherwise, try to avoid it!
-
-
-Built-in "types"
-----------------
-
-`ref` comes with all the basic fixed-size C types that you are probably familiar with:
-
-| **Name** | **Description**
-|:-------------|:-----------------------------------------------------
-| `void` | A `void` type. Derefs to `null`
-| `int8` | Signed 8-bit Integer
-| `uint8` | Unsigned 8-bit Integer
-| `int16` | Signed 16-bit Integer
-| `uint16` | Unsigned 16-bit Integer
-| `int32` | Signed 32-bit Integer
-| `uint32` | Unsigned 32-bit Integer
-| `int64` | Signed 64-bit Integer
-| `uint64` | Unsigned 64-bit Integer
-| `float` | Single Precision Floating Point Number (float)
-| `double` | Double Precision Floating Point Number (double)
-| `Object` | A type capable of reading/writing references to JS objects
-| `CString` | NULL-terminated String (char *)
-
-In addition to the basic types, there are type aliases for common C types.
-
-| **Name** | **Description**
-|:-------------|:-----------------------------------------------------
-| `bool` | bool. Returns/accepts JS `true`/`false` values
-| `byte` | unsigned char
-| `char` | char
-| `uchar` | unsigned char
-| `short` | short
-| `ushort` | unsigned short
-| `int` | int
-| `uint` | unsigned int
-| `long` | long
-| `ulong` | unsigned long
-| `longlong` | long long
-| `ulonglong` | unsigned long long
-| `size_t` | platform-dependent, usually pointer size
+See the [full API Docs][docs] for more examples.
The "type" interface
@@ -334,13 +118,13 @@ var val = buf.deref()
Build the docs
--------------
-Install the dev dependencies
+Install the dev dependencies:
``` bash
$ npm install
```
-Generate the docs
+Generate the docs:
``` bash
$ npm run docs
@@ -372,3 +156,5 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[docs]: http://tootallnate.github.com/ref
Please sign in to comment.
Something went wrong with that request. Please try again.