Skip to content

Commit a3f67c0

Browse files
authored
Fix and standardize various links in JS interop docs (#5667)
1 parent bf19bf4 commit a3f67c0

File tree

6 files changed

+45
-44
lines changed

6 files changed

+45
-44
lines changed

src/content/interop/js-interop/index.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,18 @@ iterations.
3737
[recently]: https://medium.com/dartlang/dart-3-3-325bf2bf6c13
3838
[Wasm]: {{site.flutter-docs}}/platform-integration/web/wasm
3939
[`package:web`]: {{site.pub-pkg}}/web
40-
[`dart:html`]: {{site.dart-api}}/dev/dart-html/dart-html-library.html
41-
[`dart:svg`]: {{site.dart-api}}/dev/dart-svg/dart-svg-library.html
42-
[`dart:indexed_db`]: {{site.dart-api}}/dev/dart-indexed_db/dart-indexed_db-library.html
43-
[`dart:web_audio`]: {{site.dart-api}}/dev/dart-web_audio/dart-web_audio-library.html
44-
[`dart:web_gl`]: {{site.dart-api}}/dev/dart-web_gl/dart-web_gl-library.html
45-
[`dart:js_interop`]: {{site.dart-api}}/dev/dart-js_interop/dart-js_interop-library.html
46-
[`dart:js_interop_unsafe`]: {{site.dart-api}}/dev/dart-js_interop_unsafe/dart-js_interop_unsafe-library.html
40+
[`dart:html`]: {{site.dart-api}}/dart-html/dart-html-library.html
41+
[`dart:svg`]: {{site.dart-api}}/dart-svg/dart-svg-library.html
42+
[`dart:indexed_db`]: {{site.dart-api}}/dart-indexed_db/dart-indexed_db-library.html
43+
[`dart:web_audio`]: {{site.dart-api}}/dart-web_audio/dart-web_audio-library.html
44+
[`dart:web_gl`]: {{site.dart-api}}/dart-web_gl/dart-web_gl-library.html
45+
[`dart:js_interop`]: {{site.dart-api}}/dart-js_interop/dart-js_interop-library.html
46+
[`dart:js_interop_unsafe`]: {{site.dart-api}}/dart-js_interop_unsafe/dart-js_interop_unsafe-library.html
4747
[`package:js`]: {{site.pub-api}}/js
48-
[`dart:js`]: {{site.dart-api}}/dev/dart-js/dart-js-library.html
49-
[`dart:js_util`]: {{site.dart-api}}/dev/dart-js_util/dart-js_util-library.html
48+
[`dart:js`]: {{site.dart-api}}/dart-js/dart-js-library.html
49+
[`dart:js_util`]: {{site.dart-api}}/dart-js_util/dart-js_util-library.html
5050
[Past JS interop]: /interop/js-interop/past-js-interop/
51+
5152
## Overview
5253

5354
For information on how to write and use JavaScript interop:
@@ -72,5 +73,5 @@ For additional documentation on JavaScript interop:
7273
[`package:web` and migration]: /interop/js-interop/package-web
7374
[How to mock JavaScript interop objects]: /interop/js-interop/mock
7475
[Past JS interop]: /interop/js-interop/past-js-interop
75-
[`dart:js_interop` API reference]: {{site.dart-api}}/dev/dart-js_interop/dart-js_interop-library.html
76-
[`dart:js_interop_unsafe` API reference]: {{site.dart-api}}/dev/dart-js_interop_unsafe/dart-js_interop_unsafe-library.html
76+
[`dart:js_interop` API reference]: {{site.dart-api}}/dart-js_interop/dart-js_interop-library.html
77+
[`dart:js_interop_unsafe` API reference]: {{site.dart-api}}/dart-js_interop_unsafe/dart-js_interop_unsafe-library.html

src/content/interop/js-interop/js-types.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ error if the value returned was JS `null` or `undefined` to ensure soundness.
224224
:::warning
225225
There is a subtle inconsistency with regards to `undefined` between compiling to
226226
JS and Wasm. While compiling to JS *treats* `undefined` values as if they were
227-
Dart `null`, it doesnt actually *change* the value itself. If an interop member
227+
Dart `null`, it doesn't actually *change* the value itself. If an interop member
228228
returns `undefined` and you pass that value back into JS, JS will see
229229
`undefined`, *not* `null`, when compiling to JS.
230230

@@ -244,12 +244,12 @@ but this will likely change in the future. See [#54025] for more details.
244244
TODO: add links (with stable) when ready:
245245
{% endcomment %}
246246

247-
[`dart:js_interop`]: https://api.dart.dev/dev/dart-js_interop/dart-js_interop-library.html
248-
[`external`]: https://dart.dev/language/functions#external
249-
[`Function.toJS`]: https://api.dart.dev/dev/dart-js_interop/FunctionToJSExportedDartFunction/toJS.html
250-
[`dart:js_interop` API docs]: https://api.dart.dev/dev/dart-js_interop/dart-js_interop-library.html#extension-types
251-
[`typeofEquals`]: https://api.dart.dev/dev/dart-js_interop/JSAnyUtilityExtension/typeofEquals.html
252-
[`instanceOfString`]: https://api.dart.dev/dev/dart-js_interop/JSAnyUtilityExtension/instanceOfString.html
253-
[`isA`]: https://api.dart.dev/dev/dart-js_interop/JSAnyUtilityExtension/isA.html
247+
[`dart:js_interop`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/dart-js_interop-library.html
248+
[`external`]: /language/functions#external
249+
[`Function.toJS`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/FunctionToJSExportedDartFunction/toJS.html
250+
[`dart:js_interop` API docs]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/dart-js_interop-library.html#extension-types
251+
[`typeofEquals`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyUtilityExtension/typeofEquals.html
252+
[`instanceOfString`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyUtilityExtension/instanceOfString.html
253+
[`isA`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyUtilityExtension/isA.html
254254
[#4841]: https://github.com/dart-lang/linter/issues/4841
255255
[#54025]: https://github.com/dart-lang/sdk/issues/54025

src/content/interop/js-interop/mock.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ non-instance members unless the user explicitly replaces the real API in JS.
116116
{% endcomment %}
117117

118118
[Usage]: /interop/js-interop/usage
119-
[`createJSInteropWrapper`]: https://api.dart.dev/dart-js_interop/createJSInteropWrapper.html
120-
[`@JSExport`]: https://api.dart.dev/dart-js_interop/JSExport-class.html
119+
[`createJSInteropWrapper`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/createJSInteropWrapper.html
120+
[`@JSExport`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSExport-class.html
121121
[limitation is true for extension members]: https://github.com/dart-lang/mockito/blob/master/FAQ.md#how-do-i-mock-an-extension-method
122122
[extension types]: /language/extension-types

src/content/interop/js-interop/package-web.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -283,8 +283,8 @@ Do we have any other package migrations to show off here?
283283
[Wasm]: https://github.com/dart-lang/sdk/blob/main/pkg/dart2wasm/README.md
284284
[html]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-html/dart-html-library.html
285285
[svg]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-svg/dart-svg-library.html
286-
[`dart:js_interop`]: https://api.dart.dev/dev/dart-js_interop/dart-js_interop-library.html
287-
[`dart:js_interop_unsafe`]: https://api.dart.dev/dev/dart-js_interop_unsafe/dart-js_interop_unsafe-library.html
286+
[`dart:js_interop`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/dart-js_interop-library.html
287+
[`dart:js_interop_unsafe`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop_unsafe/dart-js_interop_unsafe-library.html
288288
[idl]: https://www.npmjs.com/package/@webref/idl
289289
[interop members]: /interop/js-interop/usage#interop-members
290290
[interop types]: /interop/js-interop/usage#interop-types
@@ -293,14 +293,14 @@ Do we have any other package migrations to show off here?
293293
[helpers]: https://github.com/dart-lang/web/tree/main/lib/src/helpers
294294
[zones]: /articles/archive/zones
295295
[Conversions]: /interop/js-interop/js-types#conversions
296-
[interop methods]: https://api.dart.dev/dev/dart-js_interop/JSAnyUtilityExtension.html#instance-methods
296+
[interop methods]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyUtilityExtension.html#instance-methods
297297
[alternative interop declarations]: /interop/js-interop/usage
298298
[Compatibility, type checks, and casts]: /interop/js-interop/js-types#compatibility-type-checks-and-casts
299299
[Upgrading `url_launcher` to `package:web`]: https://github.com/flutter/packages/pull/5451/files
300300
[stream helpers]: https://github.com/dart-lang/web/blob/main/lib/src/helpers/events/streams.dart
301301
[not possible]: /language/extension-types
302-
[`JSObject`]: https://api.dart.dev/dev/dart-js_interop/JSObject-extension-type.html
303-
[`isA`]: https://api.dart.dev/dev/dart-js_interop/JSAnyUtilityExtension/isA.html
302+
[`JSObject`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSObject-extension-type.html
303+
[`isA`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyUtilityExtension/isA.html
304304
[restricts]: /interop/js-interop/js-types#requirements-on-external-declarations-and-function-tojs
305305
[#54507]: https://github.com/dart-lang/sdk/issues/54507
306306
[mocking tutorial]: /interop/js-interop/mock

src/content/interop/js-interop/past-js-interop.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -106,18 +106,18 @@ TODO: add links (with stable) when ready:
106106
TODO: Link to `package:web` section
107107
{% endcomment %}
108108

109-
[`dart:js_interop`]: https://api.dart.dev/dev/dart-js_interop
109+
[`dart:js_interop`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop
110110
[`dart:html`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-html
111111
[`package:web`]: /interop/js-interop/package-web
112112
[`dart:js`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js
113113
[`object wrapper`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js/JsObject-class.html
114114
[`allowInterop`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_util/allowInterop.html
115-
[`package:js`]: https://pub.dev/packages/js
116-
[`JSObject`]: https://api.dart.dev/dev/dart-js_interop/JSObject-extension-type.html
115+
[`package:js`]: {{site.pub-pkg}}/js
116+
[`JSObject`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSObject-extension-type.html
117117
[`@JS`]: https://github.com/dart-lang/sdk/blob/main/sdk/lib/js/_js_annotations.dart#L11
118118
[tutorial on mocking]: /interop/js-interop/mock
119119
[`@anonymous`]: https://github.com/dart-lang/sdk/blob/main/sdk/lib/js/_js_annotations.dart#L40
120120
[`@staticInterop`]: https://github.com/dart-lang/sdk/blob/main/sdk/lib/js/_js_annotations.dart#L48
121121
[`dart:js_util`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_util
122-
[`Function.toJS`]: https://api.dart.dev/dev/dart-js_interop/FunctionToJSExportedDartFunction/toJS.html
123-
[`dart:js_interop_unsafe`]: https://api.dart.dev/dev/dart-js_interop_unsafe
122+
[`Function.toJS`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/FunctionToJSExportedDartFunction/toJS.html
123+
[`dart:js_interop_unsafe`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop_unsafe

src/content/interop/js-interop/usage.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -429,27 +429,27 @@ more difficult to guarantee and may lead to violations, which is why it can be
429429
TODO: Some of these are not available on stable. How do we link to dev?
430430
{% endcomment %}
431431

432-
[global JS scope]: https://developer.mozilla.org/en-US/docs/Glossary/Global_scope
432+
[global JS scope]: https://developer.mozilla.org/docs/Glossary/Global_scope
433433
[conversion functions]: /interop/js-interop/js-types#conversions
434434
[contains a primitive type]: /interop/js-interop/js-types#requirements-on-external-declarations-and-function-tojs
435435
["JS type"]: /interop/js-interop/js-types
436-
[`Window`]: https://developer.mozilla.org/en-US/docs/Web/API/Window
436+
[`Window`]: https://developer.mozilla.org/docs/Web/API/Window
437437
[check the type of the JS value through interop]: /interop/js-interop/js-types#compatibility-type-checks-and-casts
438438
[`package:web`]: {{site.pub-pkg}}/web
439439
[`external`]: /language/functions#external
440440
[restrictions]: /interop/js-interop/js-types#requirements-on-external-declarations-and-function-tojs
441-
[object literal]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer
441+
[object literal]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/Object_initializer
442442
[54801]: https://github.com/dart-lang/sdk/issues/54801
443-
[property accessors]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors#bracket_notation
444-
[utility functions]: https://api.dart.dev/dev/dart-js_interop/JSAnyOperatorExtension.html
445-
[`@JS()`]: https://api.dart.dev/dev/dart-js_interop/JS-class.html
446-
[`dart:js_interop`]: https://api.dart.dev/dev/dart-js_interop
447-
[`globalContext`]: https://api.dart.dev/dev/dart-js_interop/globalContext.html
448-
[Helpers to inspect the type of JS values]: https://api.dart.dev/dev/dart-js_interop/JSAnyUtilityExtension.html
449-
[`dartify`]: https://api.dart.dev/dev/dart-js_interop/JSAnyUtilityExtension/dartify.html
450-
[`jsify`]: https://api.dart.dev/dev/dart-js_interop/NullableObjectUtilExtension/jsify.html
451-
[`importModule`]: https://api.dart.dev/dev/dart-js_interop/importModule.html
452-
[`dart:js_interop_unsafe`]: https://api.dart.dev/dev/dart-js_interop_unsafe
443+
[property accessors]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/Property_accessors#bracket_notation
444+
[utility functions]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyOperatorExtension.html
445+
[`@JS()`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JS-class.html
446+
[`dart:js_interop`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop
447+
[`globalContext`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/globalContext.html
448+
[Helpers to inspect the type of JS values]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyUtilityExtension.html
449+
[`dartify`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/JSAnyUtilityExtension/dartify.html
450+
[`jsify`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/NullableObjectUtilExtension/jsify.html
451+
[`importModule`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop/importModule.html
452+
[`dart:js_interop_unsafe`]: {{site.dart-api}}/{{site.sdkInfo.channel}}/dart-js_interop_unsafe/dart-js_interop_unsafe-library.html
453453
[extensions]: /language/extension-methods
454454
[extension type]: /language/extension-types
455455
[runtime guarantee]: /language/extension-types#type-considerations

0 commit comments

Comments
 (0)