fix: address build errors and add docs

cdk8s-team · Mar 13, 2023 · fbb3355 · fbb3355
1 parent 911a37a
commit fbb3355
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 2 deletions.
diff --git a/docs/java.md b/docs/java.md
@@ -97,6 +97,22 @@ public toJson()
 
 #### Static Functions <a name="Static Functions"></a>
 
+##### `isApiObject` <a name="org.cdk8s.ApiObject.isApiObject"></a>
+
+```java
+import org.cdk8s.ApiObject;
+
+ApiObject.isApiObject(java.lang.Object o)
+```
+
+###### `o`<sup>Required</sup> <a name="org.cdk8s.ApiObject.parameter.o"></a>
+
+- *Type:* `java.lang.Object`
+
+The object to check.
+
+---
+
 ##### `of` <a name="org.cdk8s.ApiObject.of"></a>
 
 ```java

diff --git a/docs/python.md b/docs/python.md
@@ -103,6 +103,24 @@ def to_json()
 
 #### Static Functions <a name="Static Functions"></a>
 
+##### `is_api_object` <a name="cdk8s.ApiObject.is_api_object"></a>
+
+```python
+import cdk8s
+
+cdk8s.ApiObject.is_api_object(
+  o: typing.Any
+)
+```
+
+###### `o`<sup>Required</sup> <a name="cdk8s.ApiObject.parameter.o"></a>
+
+- *Type:* `typing.Any`
+
+The object to check.
+
+---
+
 ##### `of` <a name="cdk8s.ApiObject.of"></a>
 
 ```python

diff --git a/docs/typescript.md b/docs/typescript.md
@@ -74,6 +74,22 @@ public toJson()
 
 #### Static Functions <a name="Static Functions"></a>
 
+##### `isApiObject` <a name="cdk8s.ApiObject.isApiObject"></a>
+
+```typescript
+import { ApiObject } from 'cdk8s'
+
+ApiObject.isApiObject(o: any)
+```
+
+###### `o`<sup>Required</sup> <a name="cdk8s.ApiObject.parameter.o"></a>
+
+- *Type:* `any`
+
+The object to check.
+
+---
+
 ##### `of` <a name="cdk8s.ApiObject.of"></a>
 
 ```typescript

diff --git a/src/api-object.ts b/src/api-object.ts
@@ -56,8 +56,8 @@ export class ApiObject extends Construct {
 
    * @param o The object to check
    */
-  static isApiObject(o: unknown): o is ApiObject {
-    return o != null && typeof o === 'object' && API_OBJECT_SYMBOL in o;
+  static isApiObject(o: any): o is ApiObject {
+    return o !== null && typeof o === 'object' && API_OBJECT_SYMBOL in o;
   }
 
   /**