Skip to content

Commit

Permalink
Updating Typescript-Deno Readme for Hub Listing
Browse files Browse the repository at this point in the history
  • Loading branch information
sordina committed Sep 16, 2023
1 parent dca2b4a commit 1617716
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions registry/typescript-deno/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Typescript (Deno) Connector allows a running connector to be inferred from a Typescript file (optionally with dependencies) and interpreted by [Deno](https://deno.com).

https://github.com/hasura/ndc-typescript-deno/tree/main#ndc-typescript-deno
[github.com/hasura/ndc-typescript-deno](https://github.com/hasura/ndc-typescript-deno/tree/main#ndc-typescript-deno)

The connector runs in the following manner:

Expand Down Expand Up @@ -35,6 +35,11 @@ export function make_password_hash(pw: string): string {
}
```

* JSDoc comments and tags are exposed in the schema
* Async, and normal functions are both supported
* Functions tagged with `@pure` annotations are exposed as functions
* Those without `@pure` annotations are exposed as procedures

## Deployment

You will need:
Expand All @@ -54,21 +59,24 @@ typescript file as mounted with the `--volume` flag.

Create the connector:

> hasura3 connector create my-cool-connector:v1 \\
> --github-repo-url https://github.com/hasura/ndc-typescript-deno/tree/main \\
> --config-file config.json \\
> --volume ./functions:/functions \\
> --env SERVICE_TOKEN_SECRET=MY-SERVICE-TOKEN
```
hasura3 connector create my-cool-connector:v1 \
--github-repo-url https://github.com/hasura/ndc-typescript-deno/tree/main \
--config-file config.json \
--volume ./functions:/functions \
--env SERVICE_TOKEN_SECRET=MY-SERVICE-TOKEN
```

Monitor the deployment status by name:

> hasura connector status my-cool-connector:v1
```
hasura connector status my-cool-connector:v1
```

List your connector with its deployed URL:

> hasura connector list
```
hasura connector list
my-cool-connector:v1 https://connector-9XXX7-hyc5v23h6a-ue.a.run.app active
```

Expand All @@ -90,5 +98,5 @@ Include the connector URL in your Hasura V3 project metadata:

## Troubleshooting

Please [https://github.com/hasura/ndc-typescript-deno/issues/new](submit a Github issue)
Please [submit a Github issue](https://github.com/hasura/ndc-typescript-deno/issues/new)
if you encounter any problems!

0 comments on commit 1617716

Please sign in to comment.