Docs for JSValueCoable-adjacent types

Author: j-f1

Sources/JavaScriptKit/JSBridgedType.swift

@@ -1,7 +1,10 @@
-// Use this protocol when your type has no single JavaScript class.
-// For example, a union type of multiple classes.
+/// Use this protocol when your type has no single JavaScript class.
+/// For example, a union type of multiple classes or primitive values.
 public protocol JSBridgedType: JSValueCodable, CustomStringConvertible {
+    /// This is the value your class wraps.
     var value: JSValue { get }
+
+    /// If your class is incompatible with the provided value, return `nil`.
     init?(from value: JSValue)
 }
 
@@ -15,10 +18,17 @@ extension JSBridgedType {
     public var description: String { value.description }
 }
 
-
+/// Conform to this protocol when your Swift class wraps a JavaScript class.
 public protocol JSBridgedClass: JSBridgedType {
+    /// The constructor function for the JavaScript class
     static var constructor: JSFunction { get }
+
+    /// The JavaScript object wrapped by this instance.
+    /// You may assume that `jsObject instanceof Self.constructor`
     var jsObject: JSObject { get }
+
+    /// Create an instannce wrapping the given JavaScript object.
+    /// You may assume that `jsObject instanceof Self.constructor`
     init(withCompatibleObject jsObject: JSObject)
 }
 

Sources/JavaScriptKit/JSValueConstructible.swift

@@ -1,4 +1,6 @@
+/// Objects that can be constructed from a JavaScript value
 public protocol JSValueConstructible {
+    /// Return `nil` if the value is not compatible with the conforming Swift type.
     static func construct(from value: JSValue) -> Self?
 }
 

Sources/JavaScriptKit/JSValueConvertible.swift

@@ -1,6 +1,8 @@
 import _CJavaScriptKit
 
+/// Objects that can be converted to a JavaScript value, preferably in a lossless manner.
 public protocol JSValueConvertible {
+    /// Create a JSValue that represents this object
     func jsValue() -> JSValue
 }
 

Sources/JavaScriptKit/Support.swift

@@ -1,5 +1,6 @@
 protocol _AnyJSValueConvertible: JSValueConvertible {}
 
+/// A type-erased wrapper for types conforming to JSValueConvertible
 public struct AnyJSValueConvertible: JSValueCodable, ExpressibleByNilLiteral {
     public static let void = AnyJSValueConvertible.construct(from: .undefined)