From 74465e106cd531f533d904fe1fa843ef635e40b9 Mon Sep 17 00:00:00 2001 From: RichardDorian Date: Thu, 7 Jul 2022 23:23:33 +0200 Subject: [PATCH] docs: :memo: update docs --- docs/classes/BufWrapper.html | 10 +++++----- docs/index.html | 1 + docs/interfaces/BufWrapperOptions.html | 6 +++--- docs/types/BufWrapperPlugins.html | 12 +++++------- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/classes/BufWrapper.html b/docs/classes/BufWrapper.html index 80b5fb1..2a9fa1b 100644 --- a/docs/classes/BufWrapper.html +++ b/docs/classes/BufWrapper.html @@ -101,35 +101,35 @@

buffer

The wrapped NodeJS buffer

 +
  • Defined in index.ts:7

    • Private buffers

    buffers: Buffer[]

    List of buffers, used for the oneConcat option

    +
  • Defined in index.ts:22

    • offset

    offset: number

    Current offset (used for reading)

    +
  • Defined in index.ts:11

    • Optional options

    options?: BufWrapperOptions<Plugins>

    Options that apply to the current BufWrapper instance

    +
  • Defined in index.ts:15

    • Optional plugins

    plugins?: Plugins

    Installed plugins so you can access them from this object

    +
  • Defined in index.ts:19

    • Methods

    diff --git a/docs/index.html b/docs/index.html index 4ee633c..3d58903 100644 --- a/docs/index.html +++ b/docs/index.html @@ -82,6 +82,7 @@

    Note on the speed

    what I got on my computer when writing 150,000 integers

    $ node test/time.js
    oneConcat = false : 7.261s
    oneConcat = true  : 63.869ms
    +

    See more here: https://minecraftjs.github.io/BufWrapper/

    diff --git a/docs/interfaces/BufWrapperOptions.html b/docs/interfaces/BufWrapperOptions.html index 6065783..3477f60 100644 --- a/docs/interfaces/BufWrapperOptions.html +++ b/docs/interfaces/BufWrapperOptions.html @@ -46,18 +46,18 @@

    Optional

    +
  • Defined in index.ts:479

    • Optional plugins

    plugins?: Plugins

    Plugins you want to install on the BufferWrapper intance you are about to create

    -

    Exemple

    // Plugin we are creating
    const BufWrapperPlugin = {
      writeCustomType(buf, data) {
        // Do stuff with `buf`
      },
      readCustomType(buf) {
        // Do stuff
        return someValue;
      }
    }

    // Setting the first argument as null
    // since we don't have any data yet
    const buf = new BufWrapper(null, {
      plugins: { BufWrapperPlugin }
    });

    // Call the plugin's method
    buf.plugins.BufWrapperPlugin.writeCustomType(buf, yourData);
+
    Exemple
    // Plugin we are creating
    const BufWrapperPlugin = {
      writeCustomType(data) {
        // You can access the BufWrapper
        // instance with the `this` keyword
      },
      readCustomType() {
        // Do stuff
        return someValue;
      }
    }

    // Setting the first argument as null
    // since we don't have any data yet
    const buf = new BufWrapper(null, {
      plugins: { BufWrapperPlugin }
    });

    // Call the plugin's method
    buf.plugins.BufWrapperPlugin.writeCustomType(yourData);
    buf.plugins.BufWrapperPlugin.readCustomType();
    +
  • Defined in index.ts:508
    • diff --git a/docs/types/BufWrapperPlugins.html b/docs/types/BufWrapperPlugins.html index 4b30090..d374d07 100644 --- a/docs/types/BufWrapperPlugins.html +++ b/docs/types/BufWrapperPlugins.html @@ -13,33 +13,31 @@
  • @minecraft-js/bufwrapper
  • BufWrapperPlugins

    • Type alias BufWrapperPlugins

    -
    BufWrapperPlugins: { [key: string]: { [key: string]: ((buf: BufWrapper, ...args: any[]) => any) } }
    +
    BufWrapperPlugins: { [key: string]: { [key: string]: ((...args: any[]) => any) } }

    Type used as default value for the BufWrapper#plugins property

    Type declaration

    • -
      [key: string]: { [key: string]: ((buf: BufWrapper, ...args: any[]) => any) }
      +
      [key: string]: { [key: string]: ((...args: any[]) => any) }
      • -
        [key: string]: ((buf: BufWrapper, ...args: any[]) => any)
        +
        [key: string]: ((...args: any[]) => any)
        • +
        • (...args: any[]): any

        • Parameters

          Returns any

    +
  • Defined in index.ts:463