Skip to content

Commit ba88e64

Browse files
committed
docs: use md docs
1 parent a5b4ed0 commit ba88e64

File tree

14 files changed

+977
-65
lines changed

14 files changed

+977
-65
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ out
88
temp
99
dist
1010
etc
11-
docs
1211

1312
package-lock.json
1413
js/**/*.js

__test__/seqpacket.spec.ts

Lines changed: 57 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { SeqpacketSocket, SeqpacketServer } from '../js/seqpacket';
44
import { kTmp, silently, createDefer, kIsDarwin, wait } from './util';
55

66
const kServerpath = path.resolve(kTmp, './seqpacket_server.sock');
7+
const kInvalidPath = path.resolve(kTmp, './INVALID_PATH');
78

89
async function createTestPair(
910
next: (args: {
@@ -344,7 +345,7 @@ if (!kIsDarwin) {
344345
client.destroy();
345346
const buf = Buffer.from('hello');
346347
expect(() => client.write(buf, 0, buf.length)).toThrow(
347-
'socket has been shutdown'
348+
'SeqpacketSocket has been destroyed'
348349
);
349350
});
350351
});
@@ -481,7 +482,7 @@ if (!kIsDarwin) {
481482
});
482483
});
483484
expect(buf.length).toBe(data.length);
484-
expect(buf.toString('hex')).toBe(data.toString('hex'))
485+
expect(buf.toString('hex')).toBe(data.toString('hex'));
485486
}
486487

487488
const smallSize = 32 * 1024;
@@ -492,18 +493,68 @@ if (!kIsDarwin) {
492493
client.write(data, 0, data.length);
493494
const buf = await new Promise<Buffer>((resolve, reject) => {
494495
socket.once('data', (buf) => {
495-
resolve(buf)
496+
resolve(buf);
496497
});
497498
});
498499

499500
expect(buf.length).toBe(smallSize);
500-
expect(buf.toString('hex')).toBe(data.slice(0, buf.length).toString('hex'))
501+
expect(buf.toString('hex')).toBe(
502+
data.slice(0, buf.length).toString('hex')
503+
);
501504
}
502505
});
503506
});
507+
508+
it('should receive messages in order and keep messages length', async () => {
509+
await createTestPair(async (args) => {
510+
const { client, socket } = args;
511+
512+
const dataToSend: Buffer[] = [];
513+
514+
for (let i = 0; i < 10; i += 1) {
515+
const buf = Buffer.allocUnsafe(Math.random() * 100 + 1);
516+
dataToSend.push(buf);
517+
}
518+
519+
let receivedIndex = 0;
520+
521+
socket.on('data', (buf) => {
522+
expect(buf.toString('hex')).toBe(
523+
dataToSend[receivedIndex].toString('hex')
524+
);
525+
receivedIndex += 1;
526+
});
527+
528+
const { p, resolve } = createDefer();
529+
socket.on('end', () => {
530+
resolve();
531+
});
532+
533+
for (const data of dataToSend) {
534+
client.write(data, 0, data.length)
535+
}
536+
client.end()
537+
538+
await p;
539+
540+
expect(receivedIndex).toBe(dataToSend.length);
541+
});
542+
});
543+
544+
it('should ref', async () => {
545+
await createTestPair(async (args) => {
546+
// TODO how to test
547+
const { client, server, socket } = args;
548+
549+
server.ref();
550+
server.unref();
551+
client.ref();
552+
client.unref();
553+
});
554+
});
504555
});
505556
} else {
506557
describe('seqpacket', () => {
507-
it('(tests skipped)', () => {})
508-
})
558+
it('(tests skipped)', () => {});
559+
});
509560
}

docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
unix-socket / [Exports](modules.md)
2+
3+
# unix-socket
4+
5+
## TODO
6+
7+
- mark that server don't work with cluster module

docs/classes/DgramSocket.md

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
[unix-socket](../README.md) / [Exports](../modules.md) / DgramSocket
2+
3+
# Class: DgramSocket
4+
5+
DgramSocket docs
6+
7+
## Hierarchy
8+
9+
- `EventEmitter`
10+
11+
**`DgramSocket`**
12+
13+
## Table of contents
14+
15+
### Constructors
16+
17+
- [constructor](DgramSocket.md#constructor)
18+
19+
### Methods
20+
21+
- [address](DgramSocket.md#address)
22+
- [bind](DgramSocket.md#bind)
23+
- [close](DgramSocket.md#close)
24+
- [getRecvBufferSize](DgramSocket.md#getrecvbuffersize)
25+
- [getSendBufferSize](DgramSocket.md#getsendbuffersize)
26+
- [sendTo](DgramSocket.md#sendto)
27+
- [setRecvBufferSize](DgramSocket.md#setrecvbuffersize)
28+
- [setSendBufferSize](DgramSocket.md#setsendbuffersize)
29+
30+
## Constructors
31+
32+
### constructor
33+
34+
**new DgramSocket**()
35+
36+
#### Overrides
37+
38+
EventEmitter.constructor
39+
40+
#### Defined in
41+
42+
dgram.ts:30
43+
44+
## Methods
45+
46+
### address
47+
48+
**address**(): `string`
49+
50+
#### Returns
51+
52+
`string`
53+
54+
#### Defined in
55+
56+
dgram.ts:107
57+
58+
___
59+
60+
### bind
61+
62+
**bind**(`socketPath`): `void`
63+
64+
Returns the average of two numbers.
65+
66+
**`remarks`**
67+
This method is part of the {@link core-library#Statistics | Statistics subsystem}.
68+
69+
#### Parameters
70+
71+
| Name | Type |
72+
| :------ | :------ |
73+
| `socketPath` | `string` |
74+
75+
#### Returns
76+
77+
`void`
78+
79+
The arithmetic mean of `x` and `y`
80+
81+
#### Defined in
82+
83+
dgram.ts:67
84+
85+
___
86+
87+
### close
88+
89+
**close**(): `void`
90+
91+
#### Returns
92+
93+
`void`
94+
95+
#### Defined in
96+
97+
dgram.ts:111
98+
99+
___
100+
101+
### getRecvBufferSize
102+
103+
**getRecvBufferSize**(): `number`
104+
105+
#### Returns
106+
107+
`number`
108+
109+
#### Defined in
110+
111+
dgram.ts:91
112+
113+
___
114+
115+
### getSendBufferSize
116+
117+
**getSendBufferSize**(): `number`
118+
119+
#### Returns
120+
121+
`number`
122+
123+
#### Defined in
124+
125+
dgram.ts:99
126+
127+
___
128+
129+
### sendTo
130+
131+
**sendTo**(`buf`, `offset`, `length`, `destPath`, `onWrite?`): `void`
132+
133+
TODO sendTo
134+
135+
#### Parameters
136+
137+
| Name | Type |
138+
| :------ | :------ |
139+
| `buf` | `Buffer` |
140+
| `offset` | `number` |
141+
| `length` | `number` |
142+
| `destPath` | `string` |
143+
| `onWrite?` | [`SendCb`](../modules.md#sendcb) |
144+
145+
#### Returns
146+
147+
`void`
148+
149+
#### Defined in
150+
151+
dgram.ts:80
152+
153+
___
154+
155+
### setRecvBufferSize
156+
157+
**setRecvBufferSize**(`size`): `void`
158+
159+
#### Parameters
160+
161+
| Name | Type |
162+
| :------ | :------ |
163+
| `size` | `number` |
164+
165+
#### Returns
166+
167+
`void`
168+
169+
#### Defined in
170+
171+
dgram.ts:95
172+
173+
___
174+
175+
### setSendBufferSize
176+
177+
**setSendBufferSize**(`size`): `void`
178+
179+
#### Parameters
180+
181+
| Name | Type |
182+
| :------ | :------ |
183+
| `size` | `number` |
184+
185+
#### Returns
186+
187+
`void`
188+
189+
#### Defined in
190+
191+
dgram.ts:103

0 commit comments

Comments
 (0)