docs(agents): Add missing tsdocs to agent-meta-transformers.ts

regal · Aug 31, 2019 · 43e35dc · 43e35dc
1 parent ac5fb10
commit 43e35dc
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/agents/impl/agent-meta-transformers.ts b/src/agents/impl/agent-meta-transformers.ts
@@ -44,5 +44,9 @@ export const inactiveAgentMeta = transformMeta(() => ({
  */
 export const agentMetaWithID = (id: AgentId) => transformMeta(() => ({ id }));
 
+/**
+ * `AgentMeta` transformer that sets the meta's prototype id to the
+ * given `protoId`.
+ */
 export const agentMetaWithProtoID = (protoId: AgentProtoId) =>
     transformMeta(() => ({ protoId }));