You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by jo...@apache.org on 2026/05/19 21:58:58 UTC
(royale-docs) 01/04: metadata: add section for [JSDynamicOverride]
This is an automated email from the ASF dual-hosted git repository.
joshtynjala pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit da17037abf80e9d5f9f78e1f8f42e0b0a73a885a
Author: Josh Tynjala <jo...@apache.org>
AuthorDate: Tue May 19 11:59:09 2026 -0700
metadata: add section for [JSDynamicOverride]
---
features/as3/metadata.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 71 insertions(+)
diff --git a/features/as3/metadata.md b/features/as3/metadata.md
index 58a0934..72f062c 100644
--- a/features/as3/metadata.md
+++ b/features/as3/metadata.md
@@ -455,6 +455,77 @@ public function get data():Object;
InstanceType
+## JSDynamicOverride
+
+_Available since Royale 1.0.0_
+
+ActionScript supports dynamically accessing object keys using square brackets, removing keys with the `delete` keyword, and checking whether a key exists with the `in` keyword. For most objects, those keys are strings. Arrays typically use integers for keys. When targeting SWF, the `flash.utils.Dictionary` class supports keys of any type.
+
+To support any type of keys when targeting JavaScript, the `[JSDynamicOverride]` metadata may be used to inform the compiler that it should translate dynamic code to method calls. There are a number of method names that may be set on this meta. All are optional, and none require any others.
+
+- `getMethod` translates `object[key]` reads
+- `setMethod` translates `object[key]` writes
+- `deleteMethod` translates `delete object[key]` removals
+- `inMethod` translates `key in object` conditions
+
+The following example demonstrates how to add this metadata to a class, and the
+expected method signatures.
+
+```as3
+[JSDynamicOverride(getMethod="getKey",setMethod="setKey",deleteMethod="deleteKey",inMethod="keyIn")]
+public interface DynamicLookup {
+ public function getKey(key:String):Object {
+ // implementation
+ }
+
+ public function setKey(key:Object, value:Object):void {
+ // implementation
+ }
+
+ public function deleteKey(key:Object):Boolean {
+ // implementation
+ }
+
+ public function keyIn(key:Object):Boolean {
+ // implementation
+ }
+}
+```
+
+The next example shows how the class above might be used:
+
+```as3
+var valueToStore:Number = 123.4;
+var key:Object = {};
+
+var obj:DynamicLookup = new DynamicLookup();
+obj[key] = valueToStore;
+
+var valueThatWasStored:Number = lookup[key];
+assertTrue(valueToStore == valueThatWasStored); // true
+
+if (key in lookup) {
+ delete lookup[key];
+}
+```
+
+When the compiler generates JavaScript from the code above, its translation will look roughly similar to the following:
+
+```js
+var valueToStore = 123.4;
+var key = {};
+
+var obj = new DynamicLookup();
+obj.setKey(key, valueToStore);
+
+var valueThatWasStored = obj.getKey(key);
+assertTrue(valueToStore == valueThatWasStored); // true
+
+if (lookup.keyIn(key)) {
+ lookup.deleteKey(key);
+}
+```
+
## JSIncludeAsset
_Available since Royale 0.9.13_