refactor(agents): Move defaultAgentMeta export to impl/index and add …

…tsdocs
regal · Aug 30, 2019 · beae458 · beae458
1 parent dd43e60
commit beae458
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/src/agents/agent.ts b/src/agents/agent.ts
@@ -10,8 +10,7 @@
  */
 
 import { AgentMeta } from "./agent-meta";
-import { buildInactiveAgentProxy } from "./impl";
-import { defaultAgentMeta } from "./impl/agent-meta-transformers";
+import { buildInactiveAgentProxy, defaultAgentMeta } from "./impl";
 
 /** Determines whether an object is an `Agent`. */
 export const isAgent = (o: any): o is Agent =>
@@ -27,6 +26,7 @@ export const isAgent = (o: any): o is Agent =>
  * a `RegalError` will be thrown.
  */
 export class Agent {
+    /** The agent's metadata, such as its agent id and prototype id. */
     public meta: AgentMeta;
 
     /**

diff --git a/src/agents/impl/index.ts b/src/agents/impl/index.ts
@@ -23,3 +23,4 @@ export {
 export {
     StaticPrototypeRegistry
 } from "./prototype/static-prototype-registry-impl";
+export { defaultAgentMeta } from "./agent-meta-transformers";