Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tag protocol-definitions and server types necessary for IQuorum to be alpha #18634

Merged
merged 1 commit into from
Dec 4, 2023
Merged

Tag protocol-definitions and server types necessary for IQuorum to be alpha #18634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions common/lib/protocol-definitions/api-report/protocol-definitions.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ export interface INackContent {
type: NackErrorType;
}

// @internal (undocumented)
// @alpha (undocumented)
export interface IProcessMessageResult {
// (undocumented)
immediateNoOp?: boolean;
Expand All @@ -201,7 +201,7 @@ export interface IProtocolState {
values: [string, ICommittedProposal][];
}

// @internal
// @alpha
export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off"> {
// (undocumented)
off: IQuorum["on"];
Expand Down Expand Up @@ -242,7 +242,7 @@ export interface IQuorumClientsEvents {
// @internal @deprecated
export type IQuorumEvents = IQuorumClientsEvents & IQuorumProposalsEvents;

// @internal
// @alpha
export interface IQuorumProposals {
// (undocumented)
get(key: string): unknown;
Expand Down
6 changes: 3 additions & 3 deletions common/lib/protocol-definitions/src/consensus.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export interface IQuorumClients {

/**
* Interface for tracking proposals in the Quorum.
* @internal
* @alpha
*/
export interface IQuorumProposals {
propose(key: string, value: unknown): Promise<void>;
Expand All @@ -128,7 +128,7 @@ export interface IQuorumProposals {

/**
* Interface combining tracking of clients as well as proposals in the Quorum.
* @internal
* @alpha
*/
export interface IQuorum
extends Omit<IQuorumClients, "on" | "once" | "off">,
Expand All @@ -150,7 +150,7 @@ export interface IProtocolState {
}

/**
* @internal
* @alpha
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any docs we can add while we're here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not sure what this is or how to describe it

*/
export interface IProcessMessageResult {
immediateNoOp?: boolean;
Expand Down