cory/tildefriends
5
6
Fork 2
Code Issues 30 Pull Requests Actions Releases 38 Wiki Activity

docs: Remove some stale docs from the api app.

Browse Source
This commit is contained in:
Cory McWilliams
2025-09-28 13:27:37 -04:00
parent c60ff86a4d
commit 53261a6fbc
3 changed files with 4 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
apps/api.json
View File

@@ -1,5 +1,5 @@
{ {
"type": "tildefriends-app", "type": "tildefriends-app",
"emoji": "📜", "emoji": "📜",
"previous": "&BEf0nraBdHk/+PWqx6tOSu5rheWVaxaL7orAOz3285M=.sha256" "previous": "&sJqeyYjHys6Z8IqqtZ2ij2ZC1E2xieu/FU/u2hE+O1U=.sha256"
} }

3
apps/api/app.js
View File

@@ -55,6 +55,9 @@ app.setDocument(`<head>
</head> </head>
<body style="color:#fff"> <body style="color:#fff">
${markdown(docs.docs.global)} ${markdown(docs.docs.global)}
<!--
${Object.keys(docs.docs).filter(x => [...treeify('', globalThis)].indexOf(x) == -1).map(x => `<p>STALE: ${x}</p>`).join('')}
-->
${[...treeify('', globalThis)].map(x => document(x)).join('\n')} ${[...treeify('', globalThis)].map(x => document(x)).join('\n')}
<a id="Database"></a> <a id="Database"></a>
${markdown(docs.docs.database)} ${markdown(docs.docs.database)}

33
apps/api/docs.js
View File

@@ -195,18 +195,6 @@ Call a function after some delay.
* *Number* **timeout** Number of milliseconds to wait before calling the callback function. * *Number* **timeout** Number of milliseconds to wait before calling the callback function.
`; `;
docs['parseHttpRequest()'] = `
Parses an HTTP request.
### Parameters
* *Uint8Array* **request** The request data. Maybe be partial or contain extra data. The return value will
indicate when and where it is complete.
* *Number* **last_length** The length of the data passed on a previous attempt for the same request, or 0 initially.
### Returns
* *Integer* **-2** if the request is incomplete.
* *Integer* **-1** if the request could not be parsed.
* *Object* An object with **bytes_parsed**, **minor_version**, **path**, and **headers** fields on successful parse.
`;
docs['parseHttpResponse()'] = ` docs['parseHttpResponse()'] = `
Parses an HTTP response. Parses an HTTP response.
### Parameters ### Parameters
@@ -219,27 +207,6 @@ Parses an HTTP response.
* *Object* An object with **bytes_parsed**, **minor_version**, **status**, **message**, and **headers** fields on successful parse. * *Object* An object with **bytes_parsed**, **minor_version**, **status**, **message**, and **headers** fields on successful parse.
`; `;
docs['sha1Digest()'] = `
Calculates a SHA1 digest.
Completes synchronously.
### Parameters
* *String* **value** The value for which to calculate the digest.
### Returns
*String* The SHA1 digest of UTF-8 encoded \`value\`.
`;
docs['maskBytes()'] = `
Masks bytes for WebSocket communication.
Completes synchronously.
### Parameters
* *Uint8Array* **bytes** The byte array of data to mask.
* *Uint32* **mask** The mask to apply.
### Returns
*Uint32Array* The masked bytes.
`;
docs['exit()'] = ` docs['exit()'] = `
Exits the app. But why would you want to do that? Exits the app. But why would you want to do that?