Improved exports and API docs

karelklima · Jan 7, 2024 · c043fae · c043fae
1 parent ae0e7a1
commit c043fae
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 8 deletions.
diff --git a/examples/basic/main.ts b/examples/basic/main.ts
@@ -21,7 +21,7 @@ const PersonSchema = {
 // Create a resource using the data schema and context above
 const Persons = createLens(PersonSchema, options);
 
-// List all persons
+// List some persons
 const persons = await Persons.find({ take: 10 });
 for (const person of persons) {
   console.log(person.name); // string

diff --git a/mod.ts b/mod.ts
@@ -8,7 +8,6 @@ export type {
   SchemaSearchInterface,
   SchemaUpdateInterface,
   SupportedDataTypes,
-  SupportedNativeTypes,
 } from "./library/schema/mod.ts";
 
 export * from "./library/lens/mod.ts";

diff --git a/tests/test_utils.ts b/tests/test_utils.ts
@@ -3,7 +3,7 @@ import { assertEquals, Comunica } from "./test_deps.ts";
 const NOLOG = Deno.args.includes("--nolog");
 export const logQuery = NOLOG ? () => {} : console.log;
 
-import { DataFactory, N3, quadsToGraph, type RDF } from "ldkit/rdf";
+import { DataFactory, N3, type RDF } from "ldkit/rdf";
 import { ldkit, schema, xsd } from "ldkit/namespaces";
 import { Options, type QueryContext } from "ldkit";
 
@@ -79,11 +79,6 @@ export const ttl = (turtle: string) => {
   return quads;
 };
 
-export const createGraph = (turtle: string) => {
-  const quads = ttl(turtle);
-  return quadsToGraph(quads);
-};
-
 export const createStore = () =>
   new N3.Store(undefined, {
     factory: DF(),

diff --git a/www/doc.config.ts b/www/doc.config.ts
@@ -19,6 +19,19 @@ const toRemoteSourceUrl = (target: string, line?: number) => {
   return `${prefix}${rootModule}${suffix}`;
 };
 
+const ignoredSymbols = [
+  "Date",
+  "Iterable",
+  "Partial",
+  "Promise",
+  "Response",
+  "Unite",
+  "T",
+  "QueryEngineProxy",
+  "QueryBuilder",
+  "ExpandedSchema",
+];
+
 export default {
   resolveHref(current, symbol, _namespace, property) {
     const path = toApiPath(current);
@@ -27,6 +40,9 @@ export default {
       : `${path}`;
   },
   lookupHref(current, namespace, symbol) {
+    if (ignoredSymbols.includes(symbol)) {
+      return undefined;
+    }
     const path = toApiPath(current);
     return namespace ? `${path}~${namespace}.${symbol}` : `${path}~${symbol}`;
   },