docs: update createNatsComponent docs

well-known-components · Jun 17, 2022 · 4bcb606 · 4bcb606
1 parent 33443fd
commit 4bcb606
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/etc/nats-component.api.md b/etc/nats-component.api.md
@@ -12,7 +12,7 @@ import { ILoggerComponent } from '@well-known-components/interfaces';
 // Warning: (ae-forgotten-export) The symbol "natsComponent" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "INatsComponent" needs to be exported by the entry point index.d.ts
 //
-// @public (undocumented)
+// @public
 export function createNatsComponent(components: natsComponent.NeededComponents): Promise<INatsComponent & IBaseComponent>;
 
 // (No @packageDocumentation comment for this package)

diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,11 @@ import { connect, NatsConnection } from "nats"
 import mitt from "mitt"
 import { natsComponent, INatsComponent, NatsEvents, Subscription } from "./types"
 
+/**
+ * Create a NATS component (https://nats.io/)
+ * Connect to a NATS node on start(), via the env variable "NATS_URL" or to "localhost:4222" by default
+ * @public
+ */
 export async function createNatsComponent(
   components: natsComponent.NeededComponents
 ): Promise<INatsComponent & IBaseComponent> {