Sovereignty/Warp
1
0
Fork 0
mirror of https://github.com/imezx/Warp.git synced 2026-06-02 12:18:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(docs): fix buffer doc

Browse source
This commit is contained in:
khtsly 2026-04-11 18:27:23 +07:00
parent 0b9bc3d39c
commit 1834e01a24
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/1.1/buffer.md
View file

@ -5,7 +5,7 @@ For efficient data serialization and schema definition with optimized packing.
## Getting the Buffer Object ## Getting the Buffer Object
```lua ```lua
local Buffer = Warp.Buffer() local Buffer = Warp.Buffer
``` ```
## Schema System <Badge type="tip" text="v1.1" /> ## Schema System <Badge type="tip" text="v1.1" />
@ -81,7 +81,7 @@ there is no standalone `"nil"` schema type. To represent a value that can be `ni
``` ```
```luau [Example] ```luau [Example]
local Buffer = Warp.Buffer() local Buffer = Warp.Buffer
-- # this custom datatype must be registered on both server & client side -- # this custom datatype must be registered on both server & client side
Buffer.Schema.custom_datatype("u64", {}, function(w: Buffer.Writer, value: any) -- just for reference Buffer.Schema.custom_datatype("u64", {}, function(w: Buffer.Writer, value: any) -- just for reference
@ -111,7 +111,7 @@ Create a new buffer writer for serializing data.
``` ```
```luau [Example] ```luau [Example]
local Buffer = Warp.Buffer() local Buffer = Warp.Buffer
local writer = Buffer.createWriter(256) -- Pre-allocate 256 bytes local writer = Buffer.createWriter(256) -- Pre-allocate 256 bytes
``` ```
::: :::
@ -128,7 +128,7 @@ Build the final buffer for transmission.
``` ```
```luau [Example] ```luau [Example]
local Buffer = Warp.Buffer() local Buffer = Warp.Buffer
local writer = Buffer.createWriter() local writer = Buffer.createWriter()
-- Write some data -- Write some data
@ -153,7 +153,7 @@ Build the final buffer with instance references for transmission.
``` ```
```luau [Example] ```luau [Example]
local Buffer = Warp.Buffer() local Buffer = Warp.Buffer
local writer = Buffer.createWriter() local writer = Buffer.createWriter()
-- Write some data with instances -- Write some data with instances
@ -178,7 +178,7 @@ Reset a writer for reuse, clearing all data.
``` ```
```luau [Example] ```luau [Example]
local Buffer = Warp.Buffer() local Buffer = Warp.Buffer
local writer = Buffer.createWriter() local writer = Buffer.createWriter()
-- Use writer for first batch -- Use writer for first batch