docs(core): document symbolic expression tranformer (#3383)

swagger-api · Nov 13, 2023 · adbda5f · adbda5f
1 parent b904cf3
commit adbda5f
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/packages/apidom-core/README.md b/packages/apidom-core/README.md
@@ -687,6 +687,25 @@ const numberElement = new NumberElement(1);
 dehyrate(numberElement); // => { element: 'number', content: 1 }
 ```
 
+### S-Expression
+
+Transforms ApiDOM into [symbolic expression](https://en.wikipedia.org/wiki/S-expression).
+
+```js
+import { sexprs, ObjectElement } from '@swagger-api/apidom-core';
+
+const objectElement = new ObjectElement({ a: 1 });
+
+sexprs(objectElement);
+// =>
+// (ObjectElement
+//   (MemberElement
+//     (StringElement)
+//     (NumberElement)))
+
+
+```
+
 ### toString
 
 Create a [refracted string](https://github.com/refractproject/refract-spec) representation of an Element.