Skip to content

Commit

Permalink
docs: setup docs for app class
Browse files Browse the repository at this point in the history
  • Loading branch information
DaniAkash committed Mar 20, 2024
1 parent ae9d84e commit 8f77f08
Show file tree
Hide file tree
Showing 10 changed files with 289 additions and 20 deletions.
Binary file removed docs/logo.png
Binary file not shown.
9 changes: 9 additions & 0 deletions examples/app/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { App } from "../../src/client/app";

export const app = new App({
authConfig: {
pat: process.env.CLARIFAI_PAT!,
userId: process.env.CLARIFAI_USER_ID!,
appId: process.env.CLARIFAI_APP_ID!,
},
});
9 changes: 9 additions & 0 deletions examples/app/listDatasets.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { app } from "./index";

app
.listDataSets()
.next()
.then((list) => {
const datasets = list.value;
console.log(datasets);
});
9 changes: 9 additions & 0 deletions examples/app/listModels.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { app } from "./index";

app
.listModels()
.next()
.then((list) => {
const models = list.value;
console.log(models);
});
9 changes: 9 additions & 0 deletions examples/app/listWorkflows.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { app } from "./index";

app
.listWorkflows()
.next()
.then((list) => {
const workflows = list.value;
console.log(workflows);
});
172 changes: 168 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"lint": "tsc --noEmit --pretty && eslint . --ignore-path .gitignore",
"watch": "parcel watch",
"build": "parcel build",
"generate-docs": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-no-inherit --out docs src/"
"generate-docs": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-no-inherit --plugin typedoc-plugin-expand-object-like-types --plugin typedoc-plugin-include-example --out docs src/"
},
"files": [
"dist/"
Expand Down Expand Up @@ -44,12 +44,15 @@
"@typescript-eslint/eslint-plugin": "^6.19.1",
"@typescript-eslint/parser": "^6.19.1",
"@vitest/coverage-v8": "^1.3.1",
"dotenv": "^16.4.5",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.3",
"parcel": "^2.11.0",
"prettier": "3.2.4",
"typedoc": "^0.25.12",
"typedoc-plugin-expand-object-like-types": "^0.1.2",
"typedoc-plugin-include-example": "^1.2.0",
"typedoc-plugin-markdown": "^3.17.1",
"typedoc-plugin-no-inherit": "^1.4.0",
"typescript": "^5.3.3",
Expand Down
Loading

0 comments on commit 8f77f08

Please sign in to comment.