Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: various v1.48.0 roll fixes for .NET #33096

Merged
merged 2 commits into from
Oct 14, 2024
Merged

chore: various v1.48.0 roll fixes for .NET #33096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a1bed3
chore: various v1.48.0 roll fixes for .NET
mxschmitt Oct 14, 2024
f62b28a
review feedback
mxschmitt Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/src/api/class-websocketroute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,19 +256,25 @@ By default, closing one side of the connection, either in the page or on the ser
### param: WebSocketRoute.onClose.handler
* since: v1.48
* langs: js, python
- `handler` <[function]\([number]|[undefined], [string]|[undefined]\): [Promise<any>|any]>
- `handler` <[function]\([int]|[undefined], [string]|[undefined]\): [Promise<any>|any]>

Function that will handle WebSocket closure. Received an optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason).

### param: WebSocketRoute.onClose.handler
* since: v1.48
* langs: java, csharp
- `handler` <[function]\([null]|[number], [null]|[string]\)>
* langs: java
- `handler` <[function]\([null]|[int], [null]|[string]\)>

Function that will handle WebSocket closure. Received an optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason).

### param: WebSocketRoute.onClose.handler
* since: v1.48
* langs: csharp
- `handler` <[function]\([int?], [string]\)>

Function that will handle WebSocket closure. Received an optional [close code](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#code) and an optional [close reason](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close#reason).

## async method: WebSocketRoute.onMessage
## method: WebSocketRoute.onMessage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ouch! I hope this is backwards-compatible.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like it, no types.d.ts changes.

* since: v1.48

This method allows to handle messages that are sent by the WebSocket, either from the page or from the server.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ Target URL.

## js-fetch-option-params
* langs: js
- `params` <[Object]<[string], [string]|[number]|[boolean]>|[URLSearchParams]|[string]>
- `params` <[Object]<[string], [string]|[float]|[boolean]>|[URLSearchParams]|[string]>

Query parameters to be sent with the URL.

Expand Down
13 changes: 8 additions & 5 deletions utils/doclint/dotnetXmlDocumentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

// @ts-check
const Documentation = require('./documentation');
const { visitAll } = require('../markdown');
const { visitAll, render } = require('../markdown');
/**
* @param {Documentation.MarkdownNode[]} nodes
* @param {number} maxColumns
Expand Down Expand Up @@ -64,7 +64,10 @@ function _innerRenderNodes(nodes, maxColumns = 80, wrapParagraphs = true) {
} else if (node.type === 'li') {
_wrapInNode('item><description', _wrapAndEscape(node, maxColumns), summary, '/description></item');
} else if (node.type === 'note') {
_wrapInNode('para', _wrapAndEscape(node, maxColumns), remarks);
_wrapInNode('para', _wrapAndEscape({
type: 'text',
text: render(node.children ?? []).replaceAll('\n', '↵'),
}, maxColumns), remarks);
}
lastNode = node;
});
Expand All @@ -75,11 +78,11 @@ function _innerRenderNodes(nodes, maxColumns = 80, wrapParagraphs = true) {

function _wrapCode(lines) {
let i = 0;
let out = [];
const out = [];
for (let line of lines) {
line = line.replace(/[&]/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
if (i < lines.length - 1)
line = line + "<br/>";
line = line + '<br/>';
out.push(line);
i++;
}
Expand Down Expand Up @@ -163,4 +166,4 @@ function renderTextOnly(nodes, maxColumns = 80) {
return result.summary;
}

module.exports = { renderXmlDoc, renderTextOnly }
module.exports = { renderXmlDoc, renderTextOnly };
5 changes: 3 additions & 2 deletions utils/doclint/generateDotnetApi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,8 @@ function renderMethod(member, parent, name, options, out) {
&& !name.startsWith('Get')
&& name !== 'CreateFormData'
&& !name.startsWith('PostDataJSON')
&& !name.startsWith('As')) {
&& !name.startsWith('As')
&& name !== 'ConnectToServer') {
if (!member.async) {
if (member.spec && !options.nodocs)
out.push(...XmlDoc.renderXmlDoc(member.spec, maxDocumentationColumnWidth));
Expand Down Expand Up @@ -718,7 +719,7 @@ function translateType(type, parent, generateNameCallback = t => t.name, optiona
if (type.expression === '[null]|[Error]')
return 'void';

if (type.name == 'Promise' && type.templates?.[0].name === 'any')
if (type.name === 'Promise' && type.templates?.[0].name === 'any')
return 'Task';

if (type.union) {
Expand Down
Loading