From dcd3e25a7b87db6d721206a20aaa81b9b4a8bc71 Mon Sep 17 00:00:00 2001 From: matthme <36768177+matthme@users.noreply.github.com> Date: Tue, 17 Dec 2024 17:45:02 +0100 Subject: [PATCH] build docs (#311) --- docs/client.chainop.md | 24 +++++++++++-------- ...ent.dhtoptype.md => client.chainoptype.md} | 6 ++--- ...opaction.md => client.getchainopaction.md} | 8 +++---- ...htopentry.md => client.getchainopentry.md} | 8 +++---- ...ature.md => client.getchainopsignature.md} | 8 +++---- ...tdhtoptype.md => client.getchainoptype.md} | 10 ++++---- docs/client.md | 12 +++++----- 7 files changed, 40 insertions(+), 36 deletions(-) rename docs/{client.dhtoptype.md => client.chainoptype.md} (77%) rename docs/{client.getdhtopaction.md => client.getchainopaction.md} (65%) rename docs/{client.getdhtopentry.md => client.getchainopentry.md} (65%) rename docs/{client.getdhtopsignature.md => client.getchainopsignature.md} (64%) rename docs/{client.getdhtoptype.md => client.getchainoptype.md} (60%) diff --git a/docs/client.chainop.md b/docs/client.chainop.md index 11389eaf..79b0d55d 100644 --- a/docs/client.chainop.md +++ b/docs/client.chainop.md @@ -9,28 +9,32 @@ ```typescript export type ChainOp = { - [DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined]; + [ChainOpType.StoreRecord]: [Signature, Action, Entry | undefined]; } | { - [DhtOpType.StoreEntry]: [Signature, NewEntryAction, Entry]; + [ChainOpType.StoreEntry]: [Signature, NewEntryAction, Entry]; } | { - [DhtOpType.RegisterAgentActivity]: [Signature, Action]; + [ChainOpType.RegisterAgentActivity]: [Signature, Action]; } | { - [DhtOpType.RegisterUpdatedContent]: [ + [ChainOpType.RegisterUpdatedContent]: [ Signature, Update, Entry | undefined ]; } | { - [DhtOpType.RegisterUpdatedRecord]: [Signature, Update, Entry | undefined]; + [ChainOpType.RegisterUpdatedRecord]: [ + Signature, + Update, + Entry | undefined + ]; } | { - [DhtOpType.RegisterDeletedBy]: [Signature, Delete]; + [ChainOpType.RegisterDeletedBy]: [Signature, Delete]; } | { - [DhtOpType.RegisterDeletedEntryAction]: [Signature, Delete]; + [ChainOpType.RegisterDeletedEntryAction]: [Signature, Delete]; } | { - [DhtOpType.RegisterAddLink]: [Signature, CreateLink]; + [ChainOpType.RegisterAddLink]: [Signature, CreateLink]; } | { - [DhtOpType.RegisterRemoveLink]: [Signature, DeleteLink]; + [ChainOpType.RegisterRemoveLink]: [Signature, DeleteLink]; }; ``` -**References:** [DhtOpType.StoreRecord](./client.dhtoptype.md), [Signature](./client.signature.md), [Action](./client.action.md), [Entry](./client.entry.md), [DhtOpType.StoreEntry](./client.dhtoptype.md), [NewEntryAction](./client.newentryaction.md), [DhtOpType.RegisterAgentActivity](./client.dhtoptype.md), [DhtOpType.RegisterUpdatedContent](./client.dhtoptype.md), [Update](./client.update.md), [DhtOpType.RegisterUpdatedRecord](./client.dhtoptype.md), [DhtOpType.RegisterDeletedBy](./client.dhtoptype.md), [Delete](./client.delete.md), [DhtOpType.RegisterDeletedEntryAction](./client.dhtoptype.md), [DhtOpType.RegisterAddLink](./client.dhtoptype.md), [CreateLink](./client.createlink.md), [DhtOpType.RegisterRemoveLink](./client.dhtoptype.md), [DeleteLink](./client.deletelink.md) +**References:** [ChainOpType.StoreRecord](./client.chainoptype.md), [Signature](./client.signature.md), [Action](./client.action.md), [Entry](./client.entry.md), [ChainOpType.StoreEntry](./client.chainoptype.md), [NewEntryAction](./client.newentryaction.md), [ChainOpType.RegisterAgentActivity](./client.chainoptype.md), [ChainOpType.RegisterUpdatedContent](./client.chainoptype.md), [Update](./client.update.md), [ChainOpType.RegisterUpdatedRecord](./client.chainoptype.md), [ChainOpType.RegisterDeletedBy](./client.chainoptype.md), [Delete](./client.delete.md), [ChainOpType.RegisterDeletedEntryAction](./client.chainoptype.md), [ChainOpType.RegisterAddLink](./client.chainoptype.md), [CreateLink](./client.createlink.md), [ChainOpType.RegisterRemoveLink](./client.chainoptype.md), [DeleteLink](./client.deletelink.md) diff --git a/docs/client.dhtoptype.md b/docs/client.chainoptype.md similarity index 77% rename from docs/client.dhtoptype.md rename to docs/client.chainoptype.md index 38f0bf6e..fb9fdc02 100644 --- a/docs/client.dhtoptype.md +++ b/docs/client.chainoptype.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [@holochain/client](./client.md) > [DhtOpType](./client.dhtoptype.md) +[Home](./index.md) > [@holochain/client](./client.md) > [ChainOpType](./client.chainoptype.md) -## DhtOpType enum +## ChainOpType enum **Signature:** ```typescript -export declare enum DhtOpType +export declare enum ChainOpType ``` ## Enumeration Members diff --git a/docs/client.getdhtopaction.md b/docs/client.getchainopaction.md similarity index 65% rename from docs/client.getdhtopaction.md rename to docs/client.getchainopaction.md index fc492271..aaa6b2f0 100644 --- a/docs/client.getdhtopaction.md +++ b/docs/client.getchainopaction.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [@holochain/client](./client.md) > [getDhtOpAction](./client.getdhtopaction.md) +[Home](./index.md) > [@holochain/client](./client.md) > [getChainOpAction](./client.getchainopaction.md) -## getDhtOpAction() function +## getChainOpAction() function **Signature:** ```typescript -export declare function getDhtOpAction(op: DhtOp): Action; +export declare function getChainOpAction(op: ChainOp): Action; ``` ## Parameters @@ -36,7 +36,7 @@ op