Skip to content

Commit c490431

Browse files
committed
docs: regenerating docs
[ci skip]
1 parent bcad31f commit c490431

File tree

344 files changed

+68159
-133
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

344 files changed

+68159
-133
lines changed
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<meta http-equiv="X-UA-Compatible" />
7+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/chart.min.js"></script>
8+
<title>git.gitClone</title>
9+
<style>
10+
body {
11+
margin: 0;
12+
padding: 0;
13+
background: #ddd;
14+
}
15+
16+
.container {
17+
box-sizing: border-box;
18+
height: 96vh;
19+
width: 96vw;
20+
margin: 2vh 2vw;
21+
resize: both;
22+
overflow: hidden;
23+
padding: 20px;
24+
background: white;
25+
box-shadow: 0 0 15px #aaa;
26+
}
27+
</style>
28+
</head>
29+
<body>
30+
<div class="container">
31+
<canvas id="chart1715663164175" width="16" height="9"></canvas>
32+
</div>
33+
<script>
34+
const format = (num) => {
35+
const [whole, fraction] = String(num).split('.')
36+
const chunked = []
37+
whole
38+
.split('')
39+
.reverse()
40+
.forEach((char, index) => {
41+
if (index % 3 === 0) {
42+
chunked.unshift([char])
43+
} else {
44+
chunked[0].unshift(char)
45+
}
46+
})
47+
48+
const fractionStr = fraction !== undefined ? '.' + fraction : ''
49+
50+
return (
51+
chunked.map((chunk) => chunk.join('')).join(' ') + fractionStr
52+
)
53+
}
54+
const ctx1715663164175 = document
55+
.getElementById('chart1715663164175')
56+
.getContext('2d')
57+
const chart1715663164175 = new Chart(ctx1715663164175, {
58+
type: 'bar',
59+
data: {
60+
labels: ["git clone with fs","git clone with efs","git clone with fs + rpc","git clone with efs + rpc"],
61+
datasets: [
62+
{
63+
data: [285.9,1.13,1.12,1.08],
64+
backgroundColor: ["hsl(120, 85%, 55%)","hsl(0.48000000000000675, 85%, 55%)","hsl(0.4680000000000007, 85%, 55%)","hsl(0.4559999999999945, 85%, 55%)"],
65+
borderColor: ["hsl(120, 85%, 55%)","hsl(0.48000000000000675, 85%, 55%)","hsl(0.4680000000000007, 85%, 55%)","hsl(0.4559999999999945, 85%, 55%)"],
66+
borderWidth: 2,
67+
},
68+
],
69+
},
70+
options: {
71+
maintainAspectRatio: false,
72+
plugins: {
73+
title: {
74+
display: true,
75+
text: 'git.gitClone',
76+
font: { size: 20 },
77+
padding: 20,
78+
},
79+
legend: {
80+
display: false,
81+
},
82+
tooltip: {
83+
callbacks: {
84+
label: (context) => {
85+
return format(context.parsed.y) + ' ops/s'
86+
},
87+
},
88+
displayColors: false,
89+
backgroundColor: '#222222',
90+
padding: 10,
91+
cornerRadius: 5,
92+
intersect: false,
93+
},
94+
},
95+
scales: {
96+
x: {
97+
grid: {
98+
color: '#888888',
99+
},
100+
},
101+
y: {
102+
title: {
103+
display: true,
104+
text: 'Operations per second',
105+
padding: 10,
106+
},
107+
grid: {
108+
color: '#888888',
109+
},
110+
},
111+
},
112+
},
113+
})
114+
</script>
115+
</body>
116+
</html>

benches/results/git/gitClone.json

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,234 @@
1+
{
2+
"name": "git.gitClone",
3+
"date": "2024-05-14T05:06:04.175Z",
4+
"version": "1.3.1",
5+
"results": [
6+
{
7+
"name": "git clone with fs",
8+
"ops": 285.9,
9+
"margin": 5.19,
10+
"options": {
11+
"delay": 0.005,
12+
"initCount": 1,
13+
"minTime": 0.05,
14+
"maxTime": 5,
15+
"minSamples": 5
16+
},
17+
"samples": 73,
18+
"promise": true,
19+
"details": {
20+
"min": 0.0027154084736842107,
21+
"max": 0.006766059055555555,
22+
"mean": 0.0034977637872066598,
23+
"median": 0.003358715333333333,
24+
"standardDeviation": 0.0007910247311976067,
25+
"marginOfError": 0.00018146158631976225,
26+
"relativeMarginOfError": 5.18793141445034,
27+
"standardErrorOfMean": 0.0000925824419998787,
28+
"sampleVariance": 6.257201253662459e-7,
29+
"sampleResults": [
30+
0.0027154084736842107,
31+
0.00273815147368421,
32+
0.0027757345263157893,
33+
0.002780739210526316,
34+
0.002782677,
35+
0.0027879403684210524,
36+
0.002797552263157895,
37+
0.002812018631578947,
38+
0.0028324016315789476,
39+
0.0028476355,
40+
0.0028583267894736844,
41+
0.0028609695000000003,
42+
0.0028689853684210525,
43+
0.0028986406666666664,
44+
0.002904041944444444,
45+
0.0029174914736842103,
46+
0.002924491388888889,
47+
0.002928144777777778,
48+
0.0029409251666666666,
49+
0.002951933117647059,
50+
0.0030185034444444444,
51+
0.003055392352941177,
52+
0.0030592592777777777,
53+
0.003073742388888889,
54+
0.0030992268823529408,
55+
0.003100035388888889,
56+
0.0031029319411764703,
57+
0.0031165888947368423,
58+
0.003152885058823529,
59+
0.0032014712222222224,
60+
0.003205313882352941,
61+
0.0032273109375,
62+
0.0032338704375,
63+
0.0032720716666666664,
64+
0.0033201861666666667,
65+
0.0033257693125,
66+
0.003358715333333333,
67+
0.003362749533333333,
68+
0.003393119444444445,
69+
0.0034055998333333334,
70+
0.003422327611111111,
71+
0.0034268420588235296,
72+
0.003430203866666667,
73+
0.003467197,
74+
0.0034861114444444444,
75+
0.0035176128888888885,
76+
0.003528548388888889,
77+
0.0035421834705882354,
78+
0.0035711061666666663,
79+
0.0036119550555555554,
80+
0.00362715325,
81+
0.0036617186666666668,
82+
0.0036657584444444447,
83+
0.0036737448888888888,
84+
0.003738180947368421,
85+
0.0037646975555555556,
86+
0.003783249388888889,
87+
0.003789516733333333,
88+
0.0038097116111111113,
89+
0.003848151,
90+
0.003875345444444444,
91+
0.003974637888888889,
92+
0.0039856986111111116,
93+
0.004071035388888889,
94+
0.0040729768888888886,
95+
0.004401614888888889,
96+
0.004438878722222222,
97+
0.004459942421052632,
98+
0.004516566888888889,
99+
0.004585082823529411,
100+
0.0062260557222222224,
101+
0.006587938611111111,
102+
0.006766059055555555
103+
]
104+
},
105+
"completed": true,
106+
"percentSlower": 0
107+
},
108+
{
109+
"name": "git clone with efs",
110+
"ops": 1.13,
111+
"margin": 2.11,
112+
"options": {
113+
"delay": 0.005,
114+
"initCount": 1,
115+
"minTime": 0.05,
116+
"maxTime": 5,
117+
"minSamples": 5
118+
},
119+
"samples": 10,
120+
"promise": true,
121+
"details": {
122+
"min": 0.844441512,
123+
"max": 0.936988432,
124+
"mean": 0.8869133151999999,
125+
"median": 0.8860309725,
126+
"standardDeviation": 0.026193721694382822,
127+
"marginOfError": 0.018736557899074267,
128+
"relativeMarginOfError": 2.1125579668233025,
129+
"standardErrorOfMean": 0.008283182095081462,
130+
"sampleVariance": 0.0006861110562027812,
131+
"sampleResults": [
132+
0.844441512,
133+
0.864125021,
134+
0.869098518,
135+
0.875580505,
136+
0.878587426,
137+
0.893474519,
138+
0.896073368,
139+
0.902214383,
140+
0.908549468,
141+
0.936988432
142+
]
143+
},
144+
"completed": true,
145+
"percentSlower": 99.6
146+
},
147+
{
148+
"name": "git clone with fs + rpc",
149+
"ops": 1.12,
150+
"margin": 3.61,
151+
"options": {
152+
"delay": 0.005,
153+
"initCount": 1,
154+
"minTime": 0.05,
155+
"maxTime": 5,
156+
"minSamples": 5
157+
},
158+
"samples": 10,
159+
"promise": true,
160+
"details": {
161+
"min": 0.833563098,
162+
"max": 0.961613677,
163+
"mean": 0.8903824716,
164+
"median": 0.8776231575,
165+
"standardDeviation": 0.0449691942870019,
166+
"marginOfError": 0.03216678875433793,
167+
"relativeMarginOfError": 3.6126933964159056,
168+
"standardErrorOfMean": 0.01422050784895576,
169+
"sampleVariance": 0.002022228434822124,
170+
"sampleResults": [
171+
0.833563098,
172+
0.841558749,
173+
0.859986109,
174+
0.861867099,
175+
0.870731132,
176+
0.884515183,
177+
0.918094687,
178+
0.921182672,
179+
0.95071231,
180+
0.961613677
181+
]
182+
},
183+
"completed": true,
184+
"percentSlower": 99.61
185+
},
186+
{
187+
"name": "git clone with efs + rpc",
188+
"ops": 1.08,
189+
"margin": 2.88,
190+
"options": {
191+
"delay": 0.005,
192+
"initCount": 1,
193+
"minTime": 0.05,
194+
"maxTime": 5,
195+
"minSamples": 5
196+
},
197+
"samples": 10,
198+
"promise": true,
199+
"details": {
200+
"min": 0.890534524,
201+
"max": 0.992862275,
202+
"mean": 0.9219758064999999,
203+
"median": 0.9087433275,
204+
"standardDeviation": 0.03712573774216667,
205+
"marginOfError": 0.02655630776214302,
206+
"relativeMarginOfError": 2.8803692651064186,
207+
"standardErrorOfMean": 0.01174018910793237,
208+
"sampleVariance": 0.0013783204029001385,
209+
"sampleResults": [
210+
0.890534524,
211+
0.891084456,
212+
0.895261198,
213+
0.896487974,
214+
0.904493645,
215+
0.91299301,
216+
0.91545642,
217+
0.941467577,
218+
0.979116986,
219+
0.992862275
220+
]
221+
},
222+
"completed": true,
223+
"percentSlower": 99.62
224+
}
225+
],
226+
"fastest": {
227+
"name": "git clone with fs",
228+
"index": 0
229+
},
230+
"slowest": {
231+
"name": "git clone with efs + rpc",
232+
"index": 3
233+
}
234+
}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# TYPE git.gitClone_ops gauge
2+
git.gitClone_ops{name="git clone with fs"} 285.9
3+
git.gitClone_ops{name="git clone with efs"} 1.13
4+
git.gitClone_ops{name="git clone with fs + rpc"} 1.12
5+
git.gitClone_ops{name="git clone with efs + rpc"} 1.08
6+
7+
# TYPE git.gitClone_margin gauge
8+
git.gitClone_margin{name="git clone with fs"} 5.19
9+
git.gitClone_margin{name="git clone with efs"} 2.11
10+
git.gitClone_margin{name="git clone with fs + rpc"} 3.61
11+
git.gitClone_margin{name="git clone with efs + rpc"} 2.88
12+
13+
# TYPE git.gitClone_samples counter
14+
git.gitClone_samples{name="git clone with fs"} 73
15+
git.gitClone_samples{name="git clone with efs"} 10
16+
git.gitClone_samples{name="git clone with fs + rpc"} 10
17+
git.gitClone_samples{name="git clone with efs + rpc"} 10

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/PolykeyAgent.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ <h5><span class="tsd-kind-parameter">password</span>: <span class="tsd-signature
455455
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
456456
<p>Inherited from CreateDestroyStartStop.destroy</p>
457457
<ul>
458-
<li>Defined in <a href="https://github.com/MatrixAI/Polykey/blob/master/src/PolykeyAgent.ts#L970">src/PolykeyAgent.ts:970</a></li></ul></aside></li></ul></section>
458+
<li>Defined in <a href="https://github.com/MatrixAI/Polykey/blob/master/src/PolykeyAgent.ts#L971">src/PolykeyAgent.ts:971</a></li></ul></aside></li></ul></section>
459459
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dispatchEvent" class="tsd-anchor"></a>
460460
<h3 class="tsd-anchor-link"><span>dispatch<wbr/>Event</span><a href="#dispatchEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
461461
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@@ -556,7 +556,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<
556556
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
557557
<p>Inherited from CreateDestroyStartStop.stop</p>
558558
<ul>
559-
<li>Defined in <a href="https://github.com/MatrixAI/Polykey/blob/master/src/PolykeyAgent.ts#L936">src/PolykeyAgent.ts:936</a></li></ul></aside></li></ul></section>
559+
<li>Defined in <a href="https://github.com/MatrixAI/Polykey/blob/master/src/PolykeyAgent.ts#L937">src/PolykeyAgent.ts:937</a></li></ul></aside></li></ul></section>
560560
<section class="tsd-panel tsd-member"><a id="createPolykeyAgent" class="tsd-anchor"></a>
561561
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>create<wbr/>Polykey<wbr/>Agent</span><a href="#createPolykeyAgent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
562562
<ul class="tsd-signatures">

0 commit comments

Comments
 (0)