From cf76b661fd93753e55bfd2e9695dc8353463891a Mon Sep 17 00:00:00 2001 From: Avi Zimmerman Date: Fri, 3 Nov 2023 02:36:58 +0200 Subject: [PATCH] tidy up doc grammar --- cmd/tsutil-gen/main.go | 22 +++++------ docs/classes/utils_rpcdb.Groups.html | 20 +++++----- docs/classes/utils_rpcdb.MeshEdges.html | 24 ++++++------ docs/classes/utils_rpcdb.MeshNodes.html | 24 ++++++------ docs/classes/utils_rpcdb.NetworkACLs.html | 20 +++++----- docs/classes/utils_rpcdb.RoleBindings.html | 20 +++++----- docs/classes/utils_rpcdb.Roles.html | 20 +++++----- docs/classes/utils_rpcdb.Routes.html | 28 +++++++------- docs/classes/v1_app_pb.AppQueryRequest.html | 10 ++--- docs/classes/v1_app_pb.ConnectRequest.html | 24 ++++++------ docs/classes/v1_app_pb.ConnectResponse.html | 20 +++++----- docs/classes/v1_app_pb.DisconnectRequest.html | 8 ++-- .../classes/v1_app_pb.DisconnectResponse.html | 6 +-- docs/classes/v1_app_pb.MeshConnBootstrap.html | 16 ++++---- .../classes/v1_app_pb.MeshConnNetworking.html | 12 +++--- docs/classes/v1_app_pb.MeshConnServices.html | 22 +++++------ docs/classes/v1_app_pb.MeshConnTLS.html | 18 ++++----- docs/classes/v1_app_pb.MetricsRequest.html | 8 ++-- docs/classes/v1_app_pb.MetricsResponse.html | 8 ++-- docs/classes/v1_app_pb.StatusRequest.html | 8 ++-- docs/classes/v1_app_pb.StatusResponse.html | 10 ++--- docs/classes/v1_members_pb.JoinRequest.html | 32 ++++++++-------- docs/classes/v1_members_pb.JoinResponse.html | 22 +++++------ docs/classes/v1_members_pb.LeaveRequest.html | 8 ++-- docs/classes/v1_members_pb.LeaveResponse.html | 6 +-- .../v1_members_pb.PeerConfigurations.html | 12 +++--- ...v1_members_pb.StorageConsensusRequest.html | 6 +-- ...1_members_pb.StorageConsensusResponse.html | 8 ++-- docs/classes/v1_members_pb.StorageServer.html | 14 +++---- .../v1_members_pb.SubscribePeersRequest.html | 8 ++-- docs/classes/v1_members_pb.UpdateRequest.html | 24 ++++++------ .../classes/v1_members_pb.UpdateResponse.html | 6 +-- docs/classes/v1_members_pb.WireGuardPeer.html | 14 +++---- docs/classes/v1_mesh_pb.GetNodeRequest.html | 8 ++-- docs/classes/v1_mesh_pb.MeshEdge.html | 14 +++---- docs/classes/v1_mesh_pb.MeshEdges.html | 8 ++-- docs/classes/v1_mesh_pb.MeshGraph.html | 12 +++--- .../v1_network_acls_pb.NetworkACL.html | 20 +++++----- .../v1_network_acls_pb.NetworkACLs.html | 8 ++-- .../v1_network_acls_pb.NetworkAction.html | 14 +++---- docs/classes/v1_network_acls_pb.Route.html | 14 +++---- docs/classes/v1_network_acls_pb.Routes.html | 8 ++-- .../v1_node_pb.DataChannelNegotiation.html | 22 +++++------ docs/classes/v1_node_pb.FeaturePort.html | 10 ++--- docs/classes/v1_node_pb.GetStatusRequest.html | 8 ++-- docs/classes/v1_node_pb.InterfaceMetrics.html | 26 ++++++------- docs/classes/v1_node_pb.MeshNode.html | 26 ++++++------- docs/classes/v1_node_pb.NodeList.html | 8 ++-- docs/classes/v1_node_pb.PeerMetrics.html | 22 +++++------ docs/classes/v1_node_pb.Status.html | 28 +++++++------- docs/classes/v1_node_pb.WebRTCSignal.html | 12 +++--- .../v1_plugin_pb.AllocateIPRequest.html | 10 ++--- docs/classes/v1_plugin_pb.AllocatedIP.html | 8 ++-- .../v1_plugin_pb.AuthenticationRequest.html | 10 ++--- .../v1_plugin_pb.AuthenticationResponse.html | 8 ++-- docs/classes/v1_plugin_pb.Event.html | 10 ++--- .../v1_plugin_pb.NodeConfiguration.html | 20 +++++----- .../v1_plugin_pb.PluginConfiguration.html | 10 ++--- docs/classes/v1_plugin_pb.PluginInfo.html | 14 +++---- .../v1_plugin_pb.ReleaseIPRequest.html | 10 ++--- .../classes/v1_raft_pb.RaftApplyResponse.html | 10 ++--- docs/classes/v1_raft_pb.RaftDataItem.html | 12 +++--- docs/classes/v1_raft_pb.RaftLogEntry.html | 14 +++---- docs/classes/v1_raft_pb.RaftSnapshot.html | 8 ++-- docs/classes/v1_rbac_pb.Group.html | 10 ++--- docs/classes/v1_rbac_pb.Groups.html | 8 ++-- docs/classes/v1_rbac_pb.RBACAction.html | 12 +++--- docs/classes/v1_rbac_pb.Role.html | 10 ++--- docs/classes/v1_rbac_pb.RoleBinding.html | 12 +++--- docs/classes/v1_rbac_pb.RoleBindings.html | 8 ++-- docs/classes/v1_rbac_pb.Roles.html | 8 ++-- docs/classes/v1_rbac_pb.Rule.html | 12 +++--- docs/classes/v1_rbac_pb.Subject.html | 10 ++--- .../v1_registrar_pb.LookupRequest.html | 12 +++--- .../v1_registrar_pb.LookupResponse.html | 12 +++--- .../v1_registrar_pb.RegisterRequest.html | 12 +++--- .../v1_registrar_pb.RegisterResponse.html | 8 ++-- ...orage_provider_pb.AddObserverResponse.html | 6 +-- ..._storage_provider_pb.AddVoterResponse.html | 6 +-- ..._storage_provider_pb.BootstrapRequest.html | 6 +-- ...storage_provider_pb.BootstrapResponse.html | 8 ++-- ...torage_provider_pb.DeleteValueRequest.html | 8 ++-- ...orage_provider_pb.DeleteValueResponse.html | 6 +-- ...orage_provider_pb.DemoteVoterResponse.html | 6 +-- ..._storage_provider_pb.GetLeaderRequest.html | 6 +-- ...1_storage_provider_pb.GetPeersRequest.html | 6 +-- ...1_storage_provider_pb.GetValueRequest.html | 8 ++-- ..._storage_provider_pb.GetValueResponse.html | 8 ++-- ...1_storage_provider_pb.ListKeysRequest.html | 8 ++-- ..._storage_provider_pb.ListKeysResponse.html | 8 ++-- ...storage_provider_pb.ListValuesRequest.html | 8 ++-- ...torage_provider_pb.ListValuesResponse.html | 8 ++-- .../v1_storage_provider_pb.PrefixEvent.html | 12 +++--- ...1_storage_provider_pb.PutValueRequest.html | 10 ++--- ..._storage_provider_pb.PutValueResponse.html | 6 +-- ...rage_provider_pb.RemoveServerResponse.html | 6 +-- .../v1_storage_provider_pb.StoragePeer.html | 14 +++---- .../v1_storage_provider_pb.StoragePeers.html | 8 ++-- .../v1_storage_provider_pb.StorageStatus.html | 14 +++---- ...rage_provider_pb.StorageStatusRequest.html | 6 +-- .../v1_storage_provider_pb.StorageValue.html | 10 ++--- ...ge_provider_pb.SubscribePrefixRequest.html | 8 ++-- .../v1_storage_query_pb.NetworkState.html | 12 +++--- .../v1_storage_query_pb.PublishRequest.html | 12 +++--- .../v1_storage_query_pb.PublishResponse.html | 6 +-- .../v1_storage_query_pb.QueryRequest.html | 14 +++---- .../v1_storage_query_pb.QueryResponse.html | 10 ++--- .../v1_storage_query_pb.SubscribeRequest.html | 8 ++-- ...v1_storage_query_pb.SubscriptionEvent.html | 10 ++--- .../v1_webrtc_pb.DataChannelOffer.html | 12 +++--- .../v1_webrtc_pb.StartDataChannelRequest.html | 18 ++++----- .../v1_app_pb.ConnectRequest_AddrType.html | 8 ++-- .../v1_app_pb.ConnectRequest_AuthHeader.html | 12 +++--- ...b.MeshConnBootstrap_DefaultNetworkACL.html | 6 +-- docs/enums/v1_app_pb.NetworkAuthMethod.html | 12 +++--- ...pp_pb.StatusResponse_ConnectionStatus.html | 8 ++-- docs/enums/v1_members_pb.ConnectProtocol.html | 8 ++-- docs/enums/v1_network_acls_pb.ACLAction.html | 8 ++-- docs/enums/v1_node_pb.ClusterStatus.html | 12 +++--- docs/enums/v1_node_pb.DataChannel.html | 6 +-- docs/enums/v1_node_pb.EdgeAttribute.html | 10 ++--- docs/enums/v1_node_pb.Feature.html | 30 +++++++-------- docs/enums/v1_plugin_pb.Event_WatchEvent.html | 10 ++--- ...plugin_pb.PluginInfo_PluginCapability.html | 14 +++---- docs/enums/v1_raft_pb.RaftCommandType.html | 8 ++-- docs/enums/v1_rbac_pb.RuleResource.html | 26 ++++++------- docs/enums/v1_rbac_pb.RuleVerb.html | 12 +++--- docs/enums/v1_rbac_pb.SubjectType.html | 12 +++--- ...age_provider_pb.PrefixEvent_EventType.html | 8 ++-- ...ge_query_pb.QueryRequest_QueryCommand.html | 10 ++--- ...orage_query_pb.QueryRequest_QueryType.html | 24 ++++++------ docs/modules/utils_rpcdb.html | 2 +- docs/modules/v1_admin_connect.html | 2 +- docs/modules/v1_app_connect.html | 2 +- docs/modules/v1_app_pb.html | 2 +- docs/modules/v1_members_connect.html | 2 +- docs/modules/v1_members_pb.html | 2 +- docs/modules/v1_mesh_connect.html | 2 +- docs/modules/v1_mesh_pb.html | 2 +- docs/modules/v1_network_acls_pb.html | 2 +- docs/modules/v1_node_connect.html | 2 +- docs/modules/v1_node_pb.html | 2 +- docs/modules/v1_plugin_connect.html | 2 +- docs/modules/v1_plugin_pb.html | 2 +- docs/modules/v1_raft_pb.html | 2 +- docs/modules/v1_rbac_pb.html | 2 +- docs/modules/v1_registrar_connect.html | 2 +- docs/modules/v1_registrar_pb.html | 2 +- docs/modules/v1_storage_provider_connect.html | 2 +- docs/modules/v1_storage_provider_pb.html | 2 +- docs/modules/v1_storage_query_connect.html | 2 +- docs/modules/v1_storage_query_pb.html | 2 +- docs/modules/v1_webrtc_connect.html | 2 +- docs/modules/v1_webrtc_pb.html | 2 +- docs/variables/v1_admin_connect.Admin.html | 2 +- docs/variables/v1_app_connect.AppDaemon.html | 2 +- .../v1_members_connect.Membership.html | 2 +- docs/variables/v1_mesh_connect.Mesh.html | 2 +- docs/variables/v1_node_connect.Node.html | 2 +- .../v1_plugin_connect.AuthPlugin.html | 2 +- .../v1_plugin_connect.IPAMPlugin.html | 2 +- docs/variables/v1_plugin_connect.Plugin.html | 2 +- ...1_plugin_connect.StorageQuerierPlugin.html | 2 +- .../v1_plugin_connect.WatchPlugin.html | 2 +- .../v1_registrar_connect.Registrar.html | 2 +- ...rovider_connect.StorageProviderPlugin.html | 2 +- ...age_query_connect.StorageQueryService.html | 2 +- docs/variables/v1_webrtc_connect.WebRTC.html | 2 +- ts/utils/rpcdb.ts | 38 +++++++++---------- 169 files changed, 856 insertions(+), 856 deletions(-) diff --git a/cmd/tsutil-gen/main.go b/cmd/tsutil-gen/main.go index 9f30926e..e0130119 100644 --- a/cmd/tsutil-gen/main.go +++ b/cmd/tsutil-gen/main.go @@ -149,10 +149,10 @@ func main() { JSImport: "node_pb", QueryType: "PEERS", Identifiers: map[string]string{ - "id": "The ID of the node.", + "id": "The ID of the node", }, ExtraGetIdentifiers: map[string]string{ - "pubkey": "The base64 encoded public key of the node.", + "pubkey": "The base64 encoded public key of the node", }, }, { @@ -160,42 +160,42 @@ func main() { JSImport: "mesh_pb", QueryType: "EDGES", Identifiers: map[string]string{ - "sourceid": "The ID of the source node.", - "targetid": "The ID of the target node.", + "sourceid": "The ID of the source node", + "targetid": "The ID of the target node", }, }, { Type: &v1.Role{}, JSImport: "rbac_pb", QueryType: "ROLES", - Identifiers: map[string]string{"id": "The name of the role."}, + Identifiers: map[string]string{"id": "The name of the role"}, }, { Type: &v1.RoleBinding{}, JSImport: "rbac_pb", QueryType: "ROLEBINDINGS", - Identifiers: map[string]string{"id": "The name of the rolebinding."}, + Identifiers: map[string]string{"id": "The name of the rolebinding"}, }, { Type: &v1.Group{}, JSImport: "rbac_pb", QueryType: "GROUPS", - Identifiers: map[string]string{"id": "The name of the group."}, + Identifiers: map[string]string{"id": "The name of the group"}, }, { Type: &v1.NetworkACL{}, JSImport: "network_acls_pb", QueryType: "ACLS", - Identifiers: map[string]string{"id": "The name of the network ACL."}, + Identifiers: map[string]string{"id": "The name of the network ACL"}, }, { Type: &v1.Route{}, JSImport: "network_acls_pb", QueryType: "ROUTES", - Identifiers: map[string]string{"id": "The name of the route."}, + Identifiers: map[string]string{"id": "The name of the route"}, ExtraListIdentifiers: map[string]string{ - "nodeid": "The ID of the node.", - "cidr": "The CIDR of the route.", + "nodeid": "The ID of the node", + "cidr": "The CIDR of the route", }, }, }, diff --git a/docs/classes/utils_rpcdb.Groups.html b/docs/classes/utils_rpcdb.Groups.html index 7ca3e828..be57a18e 100644 --- a/docs/classes/utils_rpcdb.Groups.html +++ b/docs/classes/utils_rpcdb.Groups.html @@ -1,6 +1,6 @@ Groups | Webmesh API

Class Groups

Group is the interface for working with Groups over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

-

Hierarchy

  • Groups

Constructors

constructor +

Hierarchy

  • Groups

Constructors

constructor

Properties

client connID

Methods

delete @@ -9,7 +9,7 @@ put

Constructors

constructor

  • Parameters

    • client: PromiseClient<{
          methods: {
              connect: {
                  I: typeof ConnectRequest;
                  O: typeof ConnectResponse;
                  kind: Unary;
                  name: "Connect";
              };
              disconnect: {
                  I: typeof DisconnectRequest;
                  O: typeof DisconnectResponse;
                  kind: Unary;
                  name: "Disconnect";
              };
              metrics: {
                  I: typeof MetricsRequest;
                  O: typeof MetricsResponse;
                  kind: Unary;
                  name: "Metrics";
              };
              query: {
                  I: typeof AppQueryRequest;
                  O: typeof QueryResponse;
                  kind: Unary;
                  name: "Query";
              };
              status: {
                  I: typeof StatusRequest;
                  O: typeof StatusResponse;
                  kind: Unary;
                  name: "Status";
              };
          };
          typeName: "v1.AppDaemon";
      }>

      The client to use for RPC calls.

    • connID: string

      The connection ID to use for RPC calls.

      -

    Returns Groups

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

+

Returns Groups

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      @@ -20,14 +20,14 @@

      Generated

      from rpc v1.AppDaemon.Query

    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      Generated

      from rpc v1.AppDaemon.Status

      -
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

-

Methods

delete

  • Deletes the Group with the given ID.

    -

    Parameters

    • id: string

      The name of the group..

      -

    Returns Promise<void>

get

  • Returns the Group with the given ID.

    -

    Parameters

    • id: string

      The name of the group..

      +
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

+

Methods

delete

  • Deletes the Group with the given ID.

    +

    Parameters

    • id: string

      The name of the group.

      +

    Returns Promise<void>

get

  • Returns the Group with the given ID.

    +

    Parameters

    • id: string

      The name of the group.

    Returns Promise<Group>

    The Group with the given ID.

    -

list

list

put

put

  • Puts the given Group.

    Parameters

    • obj: Group

      The Group to put into the mesh storage.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/utils_rpcdb.MeshEdges.html b/docs/classes/utils_rpcdb.MeshEdges.html index d703858c..5a5a7455 100644 --- a/docs/classes/utils_rpcdb.MeshEdges.html +++ b/docs/classes/utils_rpcdb.MeshEdges.html @@ -1,6 +1,6 @@ MeshEdges | Webmesh API

Class MeshEdges

MeshEdge is the interface for working with MeshEdges over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

-

Hierarchy

  • MeshEdges

Constructors

constructor +

Hierarchy

  • MeshEdges

Constructors

constructor

Properties

client connID

Methods

delete @@ -9,7 +9,7 @@ put

Constructors

constructor

  • Parameters

    • client: PromiseClient<{
          methods: {
              connect: {
                  I: typeof ConnectRequest;
                  O: typeof ConnectResponse;
                  kind: Unary;
                  name: "Connect";
              };
              disconnect: {
                  I: typeof DisconnectRequest;
                  O: typeof DisconnectResponse;
                  kind: Unary;
                  name: "Disconnect";
              };
              metrics: {
                  I: typeof MetricsRequest;
                  O: typeof MetricsResponse;
                  kind: Unary;
                  name: "Metrics";
              };
              query: {
                  I: typeof AppQueryRequest;
                  O: typeof QueryResponse;
                  kind: Unary;
                  name: "Query";
              };
              status: {
                  I: typeof StatusRequest;
                  O: typeof StatusResponse;
                  kind: Unary;
                  name: "Status";
              };
          };
          typeName: "v1.AppDaemon";
      }>

      The client to use for RPC calls.

    • connID: string

      The connection ID to use for RPC calls.

      -

    Returns MeshEdges

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

+

Returns MeshEdges

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      @@ -20,16 +20,16 @@

      Generated

      from rpc v1.AppDaemon.Query

    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      Generated

      from rpc v1.AppDaemon.Status

      -
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

-

Methods

delete

  • Deletes the MeshEdge with the given Sourceid and Targetid.

    -

    Parameters

    • sourceid: string

      The ID of the source node..

      -
    • targetid: string

      The ID of the target node..

      -

    Returns Promise<void>

get

  • Returns the MeshEdge with the given Sourceid and Targetid.

    -

    Parameters

    • sourceid: string

      The ID of the source node..

      -
    • targetid: string

      The ID of the target node..

      +
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

+

Methods

delete

  • Deletes the MeshEdge with the given Sourceid and Targetid.

    +

    Parameters

    • sourceid: string

      The ID of the source node.

      +
    • targetid: string

      The ID of the target node.

      +

    Returns Promise<void>

get

  • Returns the MeshEdge with the given Sourceid and Targetid.

    +

    Parameters

    • sourceid: string

      The ID of the source node.

      +
    • targetid: string

      The ID of the target node.

    Returns Promise<MeshEdge>

    The MeshEdge with the given Targetid and Sourceid.

    -

list

list

put

put

  • Puts the given MeshEdge.

    Parameters

    • obj: MeshEdge

      The MeshEdge to put into the mesh storage.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/utils_rpcdb.MeshNodes.html b/docs/classes/utils_rpcdb.MeshNodes.html index bc9ebd22..52bac1ac 100644 --- a/docs/classes/utils_rpcdb.MeshNodes.html +++ b/docs/classes/utils_rpcdb.MeshNodes.html @@ -1,6 +1,6 @@ MeshNodes | Webmesh API

Class MeshNodes

MeshNode is the interface for working with MeshNodes over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

-

Hierarchy

  • MeshNodes

Constructors

constructor +

Hierarchy

  • MeshNodes

Constructors

constructor

Properties

client connID

Methods

delete @@ -10,7 +10,7 @@ put

Constructors

constructor

  • Parameters

    • client: PromiseClient<{
          methods: {
              connect: {
                  I: typeof ConnectRequest;
                  O: typeof ConnectResponse;
                  kind: Unary;
                  name: "Connect";
              };
              disconnect: {
                  I: typeof DisconnectRequest;
                  O: typeof DisconnectResponse;
                  kind: Unary;
                  name: "Disconnect";
              };
              metrics: {
                  I: typeof MetricsRequest;
                  O: typeof MetricsResponse;
                  kind: Unary;
                  name: "Metrics";
              };
              query: {
                  I: typeof AppQueryRequest;
                  O: typeof QueryResponse;
                  kind: Unary;
                  name: "Query";
              };
              status: {
                  I: typeof StatusRequest;
                  O: typeof StatusResponse;
                  kind: Unary;
                  name: "Status";
              };
          };
          typeName: "v1.AppDaemon";
      }>

      The client to use for RPC calls.

    • connID: string

      The connection ID to use for RPC calls.

      -

    Returns MeshNodes

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

+

Returns MeshNodes

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      @@ -21,17 +21,17 @@

      Generated

      from rpc v1.AppDaemon.Query

    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      Generated

      from rpc v1.AppDaemon.Status

      -
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

-

Methods

delete

  • Deletes the MeshNode with the given ID.

    -

    Parameters

    • id: string

      The ID of the node..

      -

    Returns Promise<void>

get

  • Returns the MeshNode with the given ID.

    -

    Parameters

    • id: string

      The ID of the node..

      +
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

+

Methods

delete

  • Deletes the MeshNode with the given ID.

    +

    Parameters

    • id: string

      The ID of the node.

      +

    Returns Promise<void>

get

  • Returns the MeshNode with the given ID.

    +

    Parameters

    • id: string

      The ID of the node.

    Returns Promise<MeshNode>

    The MeshNode with the given ID.

    -

getByPubkey

  • Returns the MeshNode with the given pubkey.

    -

    Parameters

    • pubkey: string

      The base64 encoded public key of the node..

      +

getByPubkey

  • Returns the MeshNode with the given pubkey.

    +

    Parameters

    • pubkey: string

      The base64 encoded public key of the node.

    Returns Promise<MeshNode>

    The MeshNode with the given pubkey.

    -

list

list

put

put

  • Puts the given MeshNode.

    Parameters

    • obj: MeshNode

      The MeshNode to put into the mesh storage.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/utils_rpcdb.NetworkACLs.html b/docs/classes/utils_rpcdb.NetworkACLs.html index bf6231e2..ff354d07 100644 --- a/docs/classes/utils_rpcdb.NetworkACLs.html +++ b/docs/classes/utils_rpcdb.NetworkACLs.html @@ -1,6 +1,6 @@ NetworkACLs | Webmesh API

Class NetworkACLs

NetworkACL is the interface for working with NetworkACLs over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

-

Hierarchy

  • NetworkACLs

Constructors

constructor +

Hierarchy

  • NetworkACLs

Constructors

constructor

Properties

client connID

Methods

delete @@ -9,7 +9,7 @@ put

Constructors

constructor

  • Parameters

    • client: PromiseClient<{
          methods: {
              connect: {
                  I: typeof ConnectRequest;
                  O: typeof ConnectResponse;
                  kind: Unary;
                  name: "Connect";
              };
              disconnect: {
                  I: typeof DisconnectRequest;
                  O: typeof DisconnectResponse;
                  kind: Unary;
                  name: "Disconnect";
              };
              metrics: {
                  I: typeof MetricsRequest;
                  O: typeof MetricsResponse;
                  kind: Unary;
                  name: "Metrics";
              };
              query: {
                  I: typeof AppQueryRequest;
                  O: typeof QueryResponse;
                  kind: Unary;
                  name: "Query";
              };
              status: {
                  I: typeof StatusRequest;
                  O: typeof StatusResponse;
                  kind: Unary;
                  name: "Status";
              };
          };
          typeName: "v1.AppDaemon";
      }>

      The client to use for RPC calls.

    • connID: string

      The connection ID to use for RPC calls.

      -

    Returns NetworkACLs

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

+

Returns NetworkACLs

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      @@ -20,14 +20,14 @@

      Generated

      from rpc v1.AppDaemon.Query

    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      Generated

      from rpc v1.AppDaemon.Status

      -
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

-

Methods

delete

  • Deletes the NetworkACL with the given ID.

    -

    Parameters

    • id: string

      The name of the network ACL..

      -

    Returns Promise<void>

get

  • Returns the NetworkACL with the given ID.

    -

    Parameters

    • id: string

      The name of the network ACL..

      +
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

+

Methods

delete

  • Deletes the NetworkACL with the given ID.

    +

    Parameters

    • id: string

      The name of the network ACL.

      +

    Returns Promise<void>

get

  • Returns the NetworkACL with the given ID.

    +

    Parameters

    • id: string

      The name of the network ACL.

    Returns Promise<NetworkACL>

    The NetworkACL with the given ID.

    -

list

list

put

put

  • Puts the given NetworkACL.

    Parameters

    • obj: NetworkACL

      The NetworkACL to put into the mesh storage.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/utils_rpcdb.RoleBindings.html b/docs/classes/utils_rpcdb.RoleBindings.html index 98af6873..91343387 100644 --- a/docs/classes/utils_rpcdb.RoleBindings.html +++ b/docs/classes/utils_rpcdb.RoleBindings.html @@ -1,6 +1,6 @@ RoleBindings | Webmesh API

Class RoleBindings

RoleBinding is the interface for working with RoleBindings over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

-

Hierarchy

  • RoleBindings

Constructors

constructor +

Hierarchy

  • RoleBindings

Constructors

constructor

Properties

client connID

Methods

delete @@ -9,7 +9,7 @@ put

Constructors

constructor

  • Parameters

    • client: PromiseClient<{
          methods: {
              connect: {
                  I: typeof ConnectRequest;
                  O: typeof ConnectResponse;
                  kind: Unary;
                  name: "Connect";
              };
              disconnect: {
                  I: typeof DisconnectRequest;
                  O: typeof DisconnectResponse;
                  kind: Unary;
                  name: "Disconnect";
              };
              metrics: {
                  I: typeof MetricsRequest;
                  O: typeof MetricsResponse;
                  kind: Unary;
                  name: "Metrics";
              };
              query: {
                  I: typeof AppQueryRequest;
                  O: typeof QueryResponse;
                  kind: Unary;
                  name: "Query";
              };
              status: {
                  I: typeof StatusRequest;
                  O: typeof StatusResponse;
                  kind: Unary;
                  name: "Status";
              };
          };
          typeName: "v1.AppDaemon";
      }>

      The client to use for RPC calls.

    • connID: string

      The connection ID to use for RPC calls.

      -

    Returns RoleBindings

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

+

Returns RoleBindings

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      @@ -20,14 +20,14 @@

      Generated

      from rpc v1.AppDaemon.Query

    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      Generated

      from rpc v1.AppDaemon.Status

      -
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

-

Methods

delete

  • Deletes the RoleBinding with the given ID.

    -

    Parameters

    • id: string

      The name of the rolebinding..

      -

    Returns Promise<void>

get

  • Returns the RoleBinding with the given ID.

    -

    Parameters

    • id: string

      The name of the rolebinding..

      +
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

+

Methods

delete

  • Deletes the RoleBinding with the given ID.

    +

    Parameters

    • id: string

      The name of the rolebinding.

      +

    Returns Promise<void>

get

  • Returns the RoleBinding with the given ID.

    +

    Parameters

    • id: string

      The name of the rolebinding.

    Returns Promise<RoleBinding>

    The RoleBinding with the given ID.

    -

list

list

put

put

  • Puts the given RoleBinding.

    Parameters

    • obj: RoleBinding

      The RoleBinding to put into the mesh storage.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/utils_rpcdb.Roles.html b/docs/classes/utils_rpcdb.Roles.html index 3475c5d3..85729f4e 100644 --- a/docs/classes/utils_rpcdb.Roles.html +++ b/docs/classes/utils_rpcdb.Roles.html @@ -1,6 +1,6 @@ Roles | Webmesh API

Class Roles

Role is the interface for working with Roles over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

-

Hierarchy

  • Roles

Constructors

constructor +

Hierarchy

  • Roles

Constructors

constructor

Properties

client connID

Methods

delete @@ -9,7 +9,7 @@ put

Constructors

constructor

  • Parameters

    • client: PromiseClient<{
          methods: {
              connect: {
                  I: typeof ConnectRequest;
                  O: typeof ConnectResponse;
                  kind: Unary;
                  name: "Connect";
              };
              disconnect: {
                  I: typeof DisconnectRequest;
                  O: typeof DisconnectResponse;
                  kind: Unary;
                  name: "Disconnect";
              };
              metrics: {
                  I: typeof MetricsRequest;
                  O: typeof MetricsResponse;
                  kind: Unary;
                  name: "Metrics";
              };
              query: {
                  I: typeof AppQueryRequest;
                  O: typeof QueryResponse;
                  kind: Unary;
                  name: "Query";
              };
              status: {
                  I: typeof StatusRequest;
                  O: typeof StatusResponse;
                  kind: Unary;
                  name: "Status";
              };
          };
          typeName: "v1.AppDaemon";
      }>

      The client to use for RPC calls.

    • connID: string

      The connection ID to use for RPC calls.

      -

    Returns Roles

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

+

Returns Roles

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      @@ -20,14 +20,14 @@

      Generated

      from rpc v1.AppDaemon.Query

    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      Generated

      from rpc v1.AppDaemon.Status

      -
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

-

Methods

delete

  • Deletes the Role with the given ID.

    -

    Parameters

    • id: string

      The name of the role..

      -

    Returns Promise<void>

get

  • Returns the Role with the given ID.

    -

    Parameters

    • id: string

      The name of the role..

      +
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

+

Methods

delete

  • Deletes the Role with the given ID.

    +

    Parameters

    • id: string

      The name of the role.

      +

    Returns Promise<void>

get

  • Returns the Role with the given ID.

    +

    Parameters

    • id: string

      The name of the role.

    Returns Promise<Role>

    The Role with the given ID.

    -

list

list

put

put

  • Puts the given Role.

    Parameters

    • obj: Role

      The Role to put into the mesh storage.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/utils_rpcdb.Routes.html b/docs/classes/utils_rpcdb.Routes.html index c047571e..a1143690 100644 --- a/docs/classes/utils_rpcdb.Routes.html +++ b/docs/classes/utils_rpcdb.Routes.html @@ -1,6 +1,6 @@ Routes | Webmesh API

Class Routes

Route is the interface for working with Routes over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

-

Hierarchy

  • Routes

Constructors

constructor +

Hierarchy

  • Routes

Constructors

constructor

Properties

client connID

Methods

delete @@ -11,7 +11,7 @@ put

Constructors

constructor

  • Parameters

    • client: PromiseClient<{
          methods: {
              connect: {
                  I: typeof ConnectRequest;
                  O: typeof ConnectResponse;
                  kind: Unary;
                  name: "Connect";
              };
              disconnect: {
                  I: typeof DisconnectRequest;
                  O: typeof DisconnectResponse;
                  kind: Unary;
                  name: "Disconnect";
              };
              metrics: {
                  I: typeof MetricsRequest;
                  O: typeof MetricsResponse;
                  kind: Unary;
                  name: "Metrics";
              };
              query: {
                  I: typeof AppQueryRequest;
                  O: typeof QueryResponse;
                  kind: Unary;
                  name: "Query";
              };
              status: {
                  I: typeof StatusRequest;
                  O: typeof StatusResponse;
                  kind: Unary;
                  name: "Status";
              };
          };
          typeName: "v1.AppDaemon";
      }>

      The client to use for RPC calls.

    • connID: string

      The connection ID to use for RPC calls.

      -

    Returns Routes

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

+

Returns Routes

Properties

Private Readonly client

client: PromiseClient<{
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}>

The client to use for RPC calls.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      @@ -22,20 +22,20 @@

      Generated

      from rpc v1.AppDaemon.Query

    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      Generated

      from rpc v1.AppDaemon.Status

      -
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

-

Methods

delete

  • Deletes the Route with the given ID.

    -

    Parameters

    • id: string

      The name of the route..

      -

    Returns Promise<void>

get

  • Returns the Route with the given ID.

    -

    Parameters

    • id: string

      The name of the route..

      +
  • Readonly typeName: "v1.AppDaemon"

Private Readonly connID

connID: string

The connection ID to use for RPC calls.

+

Methods

delete

  • Deletes the Route with the given ID.

    +

    Parameters

    • id: string

      The name of the route.

      +

    Returns Promise<void>

get

  • Returns the Route with the given ID.

    +

    Parameters

    • id: string

      The name of the route.

    Returns Promise<Route>

    The Route with the given ID.

    -

list

list

listByCidr

  • Returns the Routes with the given cidr.

    -

    Parameters

listByCidr

  • Returns the Routes with the given cidr.

    +

    Parameters

    • cidr: string

      The CIDR of the route

    Returns Promise<Route>

    Any Routes found with the given cidr.

    -

listByNodeID

  • Returns the Routes with the given nodeid.

    -

    Parameters

listByNodeID

  • Returns the Routes with the given nodeid.

    +

    Parameters

    • nodeid: string

      The ID of the node

    Returns Promise<Route>

    Any Routes found with the given nodeid.

    -

put

put

  • Puts the given Route.

    Parameters

    • obj: Route

      The Route to put into the mesh storage.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.AppQueryRequest.html b/docs/classes/v1_app_pb.AppQueryRequest.html index 391acad4..546a9c94 100644 --- a/docs/classes/v1_app_pb.AppQueryRequest.html +++ b/docs/classes/v1_app_pb.AppQueryRequest.html @@ -1,6 +1,6 @@ AppQueryRequest | Webmesh API

Class AppQueryRequest

AppQueryRequest is sent by the application to a daemon to query a mesh's storage.

Generated

from message v1.AppQueryRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id query? fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

Generated

from field: string id = 1;

-

Optional query

query?: QueryRequest

Query is the query to execute.

+

Optional query

query?: QueryRequest

Query is the query to execute.

Generated

from field: v1.QueryRequest query = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AppQueryRequest" = "v1.AppQueryRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AppQueryRequest" = "v1.AppQueryRequest"

Methods

clone

  • Create a deep copy.

    Returns AppQueryRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.ConnectRequest.html b/docs/classes/v1_app_pb.ConnectRequest.html index 02901231..db01f9be 100644 --- a/docs/classes/v1_app_pb.ConnectRequest.html +++ b/docs/classes/v1_app_pb.ConnectRequest.html @@ -1,6 +1,6 @@ ConnectRequest | Webmesh API

Class ConnectRequest

ConnectRequest is sent by an application to a daemon to establish a connection to a mesh.

Generated

from message v1.ConnectRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

addrType addrs authCredentials @@ -27,26 +27,26 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

addrType

addrType: ConnectRequest_AddrType

AddrType is the type of join addresses in the addrs list.

+

Constructors

constructor

Properties

addrType

addrType: ConnectRequest_AddrType

AddrType is the type of join addresses in the addrs list.

Generated

from field: v1.ConnectRequest.AddrType addrType = 4;

-

addrs

addrs: string[]

Addrs are the join addresses to use to connect to the mesh.

+

addrs

addrs: string[]

Addrs are the join addresses to use to connect to the mesh.

Generated

from field: repeated string addrs = 5;

-

authCredentials

authCredentials: {
    [key: string]: Uint8Array;
}

AuthCredentials are additional credentials as required by the authType.

+

authCredentials

authCredentials: {
    [key: string]: Uint8Array;
}

AuthCredentials are additional credentials as required by the authType.

Type declaration

  • [key: string]: Uint8Array

Generated

from field: map<string, bytes> authCredentials = 3;

-

authMethod

authMethod: NetworkAuthMethod

AuthMethod is the type of authentication to use.

+

authMethod

authMethod: NetworkAuthMethod

AuthMethod is the type of authentication to use.

Generated

from field: v1.NetworkAuthMethod authMethod = 2;

-

Optional bootstrap

bootstrap?: MeshConnBootstrap

Bootstrap are options for bootstrapping a new mesh.

+

Optional bootstrap

bootstrap?: MeshConnBootstrap

Bootstrap are options for bootstrapping a new mesh.

Generated

from field: v1.MeshConnBootstrap bootstrap = 8;

-

id

id: string

ID is the unique identifier of this connection. If not provided +

id

id: string

ID is the unique identifier of this connection. If not provided one will be generated.

Generated

from field: string id = 1;

-

Optional networking

networking?: MeshConnNetworking

Networking is the networking configuration to use.

+

Optional networking

networking?: MeshConnNetworking

Networking is the networking configuration to use.

Generated

from field: v1.MeshConnNetworking networking = 6;

-

Optional services

services?: MeshConnServices

Services are the services to expose to other nodes on the mesh.

+

Optional services

services?: MeshConnServices

Services are the services to expose to other nodes on the mesh.

Generated

from field: v1.MeshConnServices services = 7;

-

Optional tls

tls?: MeshConnTLS

TLS are TLS configurations for the mesh connection.

+

Optional tls

tls?: MeshConnTLS

TLS are TLS configurations for the mesh connection.

Generated

from field: v1.MeshConnTLS tls = 9;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ConnectRequest" = "v1.ConnectRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ConnectRequest" = "v1.ConnectRequest"

Methods

clone

  • Create a deep copy.

    Returns ConnectRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -73,4 +73,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.ConnectResponse.html b/docs/classes/v1_app_pb.ConnectResponse.html index a3bff658..b3bda7b2 100644 --- a/docs/classes/v1_app_pb.ConnectResponse.html +++ b/docs/classes/v1_app_pb.ConnectResponse.html @@ -1,6 +1,6 @@ ConnectResponse | Webmesh API

Class ConnectResponse

ConnectResponse is returned by the Connect RPC.

Generated

from message v1.ConnectResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id ipv4Address ipv4Network @@ -25,21 +25,21 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

Generated

from field: string id = 1;

-

ipv4Address

ipv4Address: string

IPv4Address is the IPv4 address of the node.

+

ipv4Address

ipv4Address: string

IPv4Address is the IPv4 address of the node.

Generated

from field: string ipv4Address = 4;

-

ipv4Network

ipv4Network: string

IPv4Network is the IPv4 network of the mesh.

+

ipv4Network

ipv4Network: string

IPv4Network is the IPv4 network of the mesh.

Generated

from field: string ipv4Network = 6;

-

ipv6Address

ipv6Address: string

IPv6Address is the IPv6 address of the node.

+

ipv6Address

ipv6Address: string

IPv6Address is the IPv6 address of the node.

Generated

from field: string ipv6Address = 5;

-

ipv6Network

ipv6Network: string

IPv6Network is the IPv6 network of the mesh.

+

ipv6Network

ipv6Network: string

IPv6Network is the IPv6 network of the mesh.

Generated

from field: string ipv6Network = 7;

-

meshDomain

meshDomain: string

Mesh domain is the domain of the mesh.

+

meshDomain

meshDomain: string

Mesh domain is the domain of the mesh.

Generated

from field: string meshDomain = 3;

-

nodeID

nodeID: string

Node id is the unique identifier of the node.

+

nodeID

nodeID: string

Node id is the unique identifier of the node.

Generated

from field: string nodeID = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ConnectResponse" = "v1.ConnectResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ConnectResponse" = "v1.ConnectResponse"

Methods

clone

  • Create a deep copy.

    Returns ConnectResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -66,4 +66,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.DisconnectRequest.html b/docs/classes/v1_app_pb.DisconnectRequest.html index 35d7f6fa..2b5fc80e 100644 --- a/docs/classes/v1_app_pb.DisconnectRequest.html +++ b/docs/classes/v1_app_pb.DisconnectRequest.html @@ -1,6 +1,6 @@ DisconnectRequest | Webmesh API

Class DisconnectRequest

DisconnectRequest is sent by an application to a daemon to disconnect from a mesh.

Generated

from message v1.DisconnectRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DisconnectRequest" = "v1.DisconnectRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DisconnectRequest" = "v1.DisconnectRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.DisconnectResponse.html b/docs/classes/v1_app_pb.DisconnectResponse.html index 92d506c5..0191ddfb 100644 --- a/docs/classes/v1_app_pb.DisconnectResponse.html +++ b/docs/classes/v1_app_pb.DisconnectResponse.html @@ -1,6 +1,6 @@ DisconnectResponse | Webmesh API

Class DisconnectResponse

DisconnectResponse is returned by the Disconnect RPC.

Generated

from message v1.DisconnectResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DisconnectResponse" = "v1.DisconnectResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DisconnectResponse" = "v1.DisconnectResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.MeshConnBootstrap.html b/docs/classes/v1_app_pb.MeshConnBootstrap.html index 6f5f9a8c..04cc2e5f 100644 --- a/docs/classes/v1_app_pb.MeshConnBootstrap.html +++ b/docs/classes/v1_app_pb.MeshConnBootstrap.html @@ -1,6 +1,6 @@ MeshConnBootstrap | Webmesh API

Class MeshConnBootstrap

MeshConnBootstrap are configurations for bootstrapping a new mesh.

Generated

from message v1.MeshConnBootstrap

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

defaultNetworkACL domain enabled @@ -23,17 +23,17 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

defaultNetworkACL

defaultNetworkACL: MeshConnBootstrap_DefaultNetworkACL

DefaultNetworkACL is the default network ACL to use for the mesh.

+

Constructors

constructor

Properties

defaultNetworkACL

defaultNetworkACL: MeshConnBootstrap_DefaultNetworkACL

DefaultNetworkACL is the default network ACL to use for the mesh.

Generated

from field: v1.MeshConnBootstrap.DefaultNetworkACL defaultNetworkACL = 5;

-

domain

domain: string

Domain is the domain of the mesh. Defaults to "webmesh.internal".

+

domain

domain: string

Domain is the domain of the mesh. Defaults to "webmesh.internal".

Generated

from field: string domain = 2;

-

enabled

enabled: boolean

Enabled indicates whether or not to bootstrap a new mesh.

+

enabled

enabled: boolean

Enabled indicates whether or not to bootstrap a new mesh.

Generated

from field: bool enabled = 1;

-

ipv4Network

ipv4Network: string

IPv4Network is the IPv4 network of the mesh. Defaults to 172.16.0.0/12.

+

ipv4Network

ipv4Network: string

IPv4Network is the IPv4 network of the mesh. Defaults to 172.16.0.0/12.

Generated

from field: string ipv4Network = 3;

-

rbacEnabled

rbacEnabled: boolean

RBACEnabled indicates whether or not to enable RBAC on the mesh.

+

rbacEnabled

rbacEnabled: boolean

RBACEnabled indicates whether or not to enable RBAC on the mesh.

Generated

from field: bool rbacEnabled = 4;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnBootstrap" = "v1.MeshConnBootstrap"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnBootstrap" = "v1.MeshConnBootstrap"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -60,4 +60,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.MeshConnNetworking.html b/docs/classes/v1_app_pb.MeshConnNetworking.html index 0087824d..5c78ddb4 100644 --- a/docs/classes/v1_app_pb.MeshConnNetworking.html +++ b/docs/classes/v1_app_pb.MeshConnNetworking.html @@ -1,6 +1,6 @@ MeshConnNetworking | Webmesh API

Class MeshConnNetworking

MeshConnNetworking are configurations for networking on a mesh.

Generated

from message v1.MeshConnNetworking

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

detectEndpoints endpoints useDNS @@ -21,13 +21,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

detectEndpoints

detectEndpoints: boolean

DetectEndpoints enables endpoint detection.

+

Constructors

constructor

Properties

detectEndpoints

detectEndpoints: boolean

DetectEndpoints enables endpoint detection.

Generated

from field: bool detectEndpoints = 3;

-

endpoints

endpoints: string[]

Endpoints are wireguard endpoints to broadcast to the mesh.

+

endpoints

endpoints: string[]

Endpoints are wireguard endpoints to broadcast to the mesh.

Generated

from field: repeated string endpoints = 2;

-

useDNS

useDNS: boolean

UseDNS indicates whether or not to use the DNS servers of the mesh.

+

useDNS

useDNS: boolean

UseDNS indicates whether or not to use the DNS servers of the mesh.

Generated

from field: bool useDNS = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnNetworking" = "v1.MeshConnNetworking"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnNetworking" = "v1.MeshConnNetworking"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -54,4 +54,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.MeshConnServices.html b/docs/classes/v1_app_pb.MeshConnServices.html index 16e1f90b..e897ca8f 100644 --- a/docs/classes/v1_app_pb.MeshConnServices.html +++ b/docs/classes/v1_app_pb.MeshConnServices.html @@ -1,6 +1,6 @@ MeshConnServices | Webmesh API

Class MeshConnServices

MeshConnServices are configurations for exposing services to other nodes on a mesh.

Generated

from message v1.MeshConnServices

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

authMethod enableLibP2P enableTLS @@ -26,26 +26,26 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

authMethod

authMethod: NetworkAuthMethod

AuthMetod is the of authentication to enable for the services. +

Constructors

constructor

Properties

authMethod

authMethod: NetworkAuthMethod

AuthMetod is the of authentication to enable for the services. Only mTLS and ID are supported.

Generated

from field: v1.NetworkAuthMethod authMethod = 7;

-

enableLibP2P

enableLibP2P: boolean

EnableLibP2P indicates whether or not to serve the API over libp2p.

+

enableLibP2P

enableLibP2P: boolean

EnableLibP2P indicates whether or not to serve the API over libp2p.

Generated

from field: bool enableLibP2P = 2;

-

enableTLS

enableTLS: boolean

EnableTLS indicates whether or not to use TLS for the API.

+

enableTLS

enableTLS: boolean

EnableTLS indicates whether or not to use TLS for the API.

Generated

from field: bool enableTLS = 3;

-

enabled

enabled: boolean

Enabled indicates whether or not to expose services to other nodes.

+

enabled

enabled: boolean

Enabled indicates whether or not to expose services to other nodes.

Generated

from field: bool enabled = 1;

-

features

features: Feature[]

Features are which features to enable on the API.

+

features

features: Feature[]

Features are which features to enable on the API.

Generated

from field: repeated v1.Feature features = 8;

-

listenAddress

listenAddress: string

ListenAddress is a raw IP address and port to listen on.

+

listenAddress

listenAddress: string

ListenAddress is a raw IP address and port to listen on.

Generated

from field: string listenAddress = 5;

-

listenMultiaddrs

listenMultiaddrs: string[]

ListenMultiaddrs are multiaddrs to listen on. If not provided and +

listenMultiaddrs

listenMultiaddrs: string[]

ListenMultiaddrs are multiaddrs to listen on. If not provided and EnableLibP2P is set, the default listen addresses will be used.

Generated

from field: repeated string listenMultiaddrs = 6;

-

rendezvous

rendezvous: string

Rendezvous is an optional rendezvous string to use for anouncing the service +

rendezvous

rendezvous: string

Rendezvous is an optional rendezvous string to use for anouncing the service on the IPFS DHT.

Generated

from field: string rendezvous = 4;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnServices" = "v1.MeshConnServices"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnServices" = "v1.MeshConnServices"

Methods

clone

  • Create a deep copy.

    Returns MeshConnServices

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -72,4 +72,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.MeshConnTLS.html b/docs/classes/v1_app_pb.MeshConnTLS.html index 8ae90db6..13e29d66 100644 --- a/docs/classes/v1_app_pb.MeshConnTLS.html +++ b/docs/classes/v1_app_pb.MeshConnTLS.html @@ -1,6 +1,6 @@ MeshConnTLS | Webmesh API

Class MeshConnTLS

MeshhConnTLS are TLS configurations for a mesh connection.

Generated

from message v1.MeshConnTLS

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

caCertData certData enabled @@ -24,21 +24,21 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

caCertData

caCertData: Uint8Array

CACert is a PEM-encoded CA certificate to use for TLS.

+

Constructors

constructor

Properties

caCertData

caCertData: Uint8Array

CACert is a PEM-encoded CA certificate to use for TLS.

Generated

from field: bytes caCertData = 2;

-

certData

certData: Uint8Array

CertData is a PEM-encoded certificate to use for TLS.

+

certData

certData: Uint8Array

CertData is a PEM-encoded certificate to use for TLS.

Generated

from field: bytes certData = 3;

-

enabled

enabled: boolean

Enabled indicates whether or not to use TLS.

+

enabled

enabled: boolean

Enabled indicates whether or not to use TLS.

Generated

from field: bool enabled = 1;

-

keyData

keyData: Uint8Array

KeyData is a PEM-encoded private key to use for TLS.

+

keyData

keyData: Uint8Array

KeyData is a PEM-encoded private key to use for TLS.

Generated

from field: bytes keyData = 4;

-

skipVerify

skipVerify: boolean

SkipVerify indicates whether or not to skip verification of the +

skipVerify

skipVerify: boolean

SkipVerify indicates whether or not to skip verification of the server certificate.

Generated

from field: bool skipVerify = 6;

-

verifyChainOnly

verifyChainOnly: boolean

VerifyChainOnly indicates whether or not to only verify the +

verifyChainOnly

verifyChainOnly: boolean

VerifyChainOnly indicates whether or not to only verify the certificate chain.

Generated

from field: bool verifyChainOnly = 5;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnTLS" = "v1.MeshConnTLS"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshConnTLS" = "v1.MeshConnTLS"

Methods

clone

  • Create a deep copy.

    Returns MeshConnTLS

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -65,4 +65,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.MetricsRequest.html b/docs/classes/v1_app_pb.MetricsRequest.html index 26434421..9436ef9e 100644 --- a/docs/classes/v1_app_pb.MetricsRequest.html +++ b/docs/classes/v1_app_pb.MetricsRequest.html @@ -1,6 +1,6 @@ MetricsRequest | Webmesh API

Class MetricsRequest

MetricsRequest is sent by the application to a daemon to retrieve interface metrics for a mesh connection.

Generated

from message v1.MetricsRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

ids fields runtime @@ -19,10 +19,10 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

ids

ids: string[]

IDs are the unique identifiers of the connections to retrieve metrics for. +

Constructors

constructor

Properties

ids

ids: string[]

IDs are the unique identifiers of the connections to retrieve metrics for. If not provided, metrics for all connections will be returned.

Generated

from field: repeated string ids = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MetricsRequest" = "v1.MetricsRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MetricsRequest" = "v1.MetricsRequest"

Methods

clone

  • Create a deep copy.

    Returns MetricsRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -49,4 +49,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.MetricsResponse.html b/docs/classes/v1_app_pb.MetricsResponse.html index 1b9165ae..19d10179 100644 --- a/docs/classes/v1_app_pb.MetricsResponse.html +++ b/docs/classes/v1_app_pb.MetricsResponse.html @@ -1,6 +1,6 @@ MetricsResponse | Webmesh API

Class MetricsResponse

MetricsResponse is a message containing interface metrics.

Generated

from message v1.MetricsResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

interfaces fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

interfaces

interfaces: {
    [key: string]: InterfaceMetrics;
}

Interfaces is a map of network IDs to their interface metrics.

+

Constructors

constructor

Properties

interfaces

interfaces: {
    [key: string]: InterfaceMetrics;
}

Interfaces is a map of network IDs to their interface metrics.

Type declaration

Generated

from field: map<string, v1.InterfaceMetrics> interfaces = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MetricsResponse" = "v1.MetricsResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MetricsResponse" = "v1.MetricsResponse"

Methods

clone

  • Create a deep copy.

    Returns MetricsResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.StatusRequest.html b/docs/classes/v1_app_pb.StatusRequest.html index a083bc6d..71f848dd 100644 --- a/docs/classes/v1_app_pb.StatusRequest.html +++ b/docs/classes/v1_app_pb.StatusRequest.html @@ -1,6 +1,6 @@ StatusRequest | Webmesh API

Class StatusRequest

StatusRequest is sent by the application to a daemon to retrieve the status of a mesh connection.

Generated

from message v1.StatusRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StatusRequest" = "v1.StatusRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StatusRequest" = "v1.StatusRequest"

Methods

clone

  • Create a deep copy.

    Returns StatusRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_app_pb.StatusResponse.html b/docs/classes/v1_app_pb.StatusResponse.html index 867fa502..426c0b71 100644 --- a/docs/classes/v1_app_pb.StatusResponse.html +++ b/docs/classes/v1_app_pb.StatusResponse.html @@ -1,6 +1,6 @@ StatusResponse | Webmesh API

Class StatusResponse

StatusResponse is a message containing the status of the node.

Generated

from message v1.StatusResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

connectionStatus node? fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

connectionStatus

connectionStatus: StatusResponse_ConnectionStatus

ConnectionStatus is the status of the connection.

+

Constructors

constructor

Properties

connectionStatus

connectionStatus: StatusResponse_ConnectionStatus

ConnectionStatus is the status of the connection.

Generated

from field: v1.StatusResponse.ConnectionStatus connectionStatus = 1;

-

Optional node

node?: MeshNode

Node is the node status. This is only populated if the node is connected.

+

Optional node

node?: MeshNode

Node is the node status. This is only populated if the node is connected.

Generated

from field: v1.MeshNode node = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StatusResponse" = "v1.StatusResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StatusResponse" = "v1.StatusResponse"

Methods

clone

  • Create a deep copy.

    Returns StatusResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.JoinRequest.html b/docs/classes/v1_members_pb.JoinRequest.html index ae5f7200..9e426418 100644 --- a/docs/classes/v1_members_pb.JoinRequest.html +++ b/docs/classes/v1_members_pb.JoinRequest.html @@ -1,6 +1,6 @@ JoinRequest | Webmesh API

Class JoinRequest

JoinRequest is a request to join the cluster.

Generated

from message v1.JoinRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

asObserver asVoter assignIPv4 @@ -31,15 +31,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

asObserver

asObserver: boolean

AsObserver is whether the node should be added as an observer. They will receive +

Constructors

constructor

Properties

asObserver

asObserver: boolean

AsObserver is whether the node should be added as an observer. They will receive updates to the storage, but not be able to vote in elections.

Generated

from field: bool asObserver = 10;

-

asVoter

asVoter: boolean

AsVoter is whether the node should receive a vote in elections. The request +

asVoter

asVoter: boolean

AsVoter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.

Generated

from field: bool asVoter = 9;

-

assignIPv4

assignIPv4: boolean

AssignIPv4 is whether an IPv4 address should be assigned to the node.

+

assignIPv4

assignIPv4: boolean

AssignIPv4 is whether an IPv4 address should be assigned to the node.

Generated

from field: bool assignIPv4 = 7;

-

directPeers

directPeers: {
    [key: string]: ConnectProtocol;
}

DirectPeers is a map of extra peers that should be connected to directly over relays. +

directPeers

directPeers: {
    [key: string]: ConnectProtocol;
}

DirectPeers is a map of extra peers that should be connected to directly over relays. The provided edge attribute is the callers preference of how the relay should be created. The request will be denied if the node is not allowed to put data channels or edges. The default joining behavior creates direct links between the caller and the joiner. @@ -48,29 +48,29 @@ the joiner will link the caller to all other nodes with the same zone awareness ID that also have a primary endpoint.

Type declaration

Generated

from field: map<string, v1.ConnectProtocol> directPeers = 12;

-

features

features: FeaturePort[]

Features is a list of features supported by the node that should be advertised to peers +

features

features: FeaturePort[]

Features is a list of features supported by the node that should be advertised to peers and the port they are available on.

Generated

from field: repeated v1.FeaturePort features = 13;

-

id

id: string

ID is the ID of the node.

+

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

multiaddrs

multiaddrs: string[]

Multiaddrs are libp2p multiaddresses this node is listening on.

+

multiaddrs

multiaddrs: string[]

Multiaddrs are libp2p multiaddresses this node is listening on.

Generated

from field: repeated string multiaddrs = 14;

-

preferStorageIPv6

preferStorageIPv6: boolean

PreferStorageIPv6 is whether IPv6 should be preferred over IPv4 for storage communication. +

preferStorageIPv6

preferStorageIPv6: boolean

PreferStorageIPv6 is whether IPv6 should be preferred over IPv4 for storage communication. This is only used if assign_ipv4 is true.

Generated

from field: bool preferStorageIPv6 = 8;

-

primaryEndpoint

primaryEndpoint: string

PrimaryEndpoint is a routable address for the node. If left unset, +

primaryEndpoint

primaryEndpoint: string

PrimaryEndpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.

Generated

from field: string primaryEndpoint = 4;

-

publicKey

publicKey: string

PublicKey is the public key of the node to broadcast to peers.

+

publicKey

publicKey: string

PublicKey is the public key of the node to broadcast to peers.

Generated

from field: string publicKey = 2;

-

routes

routes: string[]

Routes is a list of routes to advertise to peers. The request will be denied +

routes

routes: string[]

Routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.

Generated

from field: repeated string routes = 11;

-

wireguardEndpoints

wireguardEndpoints: string[]

WireguardEndpoints is a list of WireGuard endpoints for the node.

+

wireguardEndpoints

wireguardEndpoints: string[]

WireguardEndpoints is a list of WireGuard endpoints for the node.

Generated

from field: repeated string wireguardEndpoints = 5;

-

zoneAwarenessID

zoneAwarenessID: string

ZoneAwarenessID is the zone awareness ID of the node.

+

zoneAwarenessID

zoneAwarenessID: string

ZoneAwarenessID is the zone awareness ID of the node.

Generated

from field: string zoneAwarenessID = 6;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.JoinRequest" = "v1.JoinRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.JoinRequest" = "v1.JoinRequest"

Methods

clone

  • Create a deep copy.

    Returns JoinRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -97,4 +97,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.JoinResponse.html b/docs/classes/v1_members_pb.JoinResponse.html index 66ed9c85..c949846e 100644 --- a/docs/classes/v1_members_pb.JoinResponse.html +++ b/docs/classes/v1_members_pb.JoinResponse.html @@ -1,6 +1,6 @@ JoinResponse | Webmesh API

Class JoinResponse

JoinResponse is a response to a join request.

Generated

from message v1.JoinResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

addressIPv4 addressIPv6 dnsServers @@ -26,28 +26,28 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

addressIPv4

addressIPv4: string

AddressIPv4 is the private IPv4 wireguard address of the node +

Constructors

constructor

Properties

addressIPv4

addressIPv4: string

AddressIPv4 is the private IPv4 wireguard address of the node in CIDR format representing the network. This is only set if assign_ipv4 was set in the request or no network_ipv6 was provided.

Generated

from field: string addressIPv4 = 1;

-

addressIPv6

addressIPv6: string

AddressIPv6 is the IPv6 network assigned to the node.

+

addressIPv6

addressIPv6: string

AddressIPv6 is the IPv6 network assigned to the node.

Generated

from field: string addressIPv6 = 2;

-

dnsServers

dnsServers: string[]

DNSServers is a list of peers offering DNS services.

+

dnsServers

dnsServers: string[]

DNSServers is a list of peers offering DNS services.

Generated

from field: repeated string dnsServers = 7;

-

iceServers

iceServers: string[]

ICEServers is a list of public nodes that can be used to negotiate +

iceServers

iceServers: string[]

ICEServers is a list of public nodes that can be used to negotiate ICE connections if required. This may only be populated when one of the peers has the ICE flag set. This must be set if the requestor specifies direct_peers.

Generated

from field: repeated string iceServers = 6;

-

meshDomain

meshDomain: string

MeshDomain is the domain of the mesh.

+

meshDomain

meshDomain: string

MeshDomain is the domain of the mesh.

Generated

from field: string meshDomain = 8;

-

networkIPv4

networkIPv4: string

NetworkIPv4 is the IPv4 network of the Mesh.

+

networkIPv4

networkIPv4: string

NetworkIPv4 is the IPv4 network of the Mesh.

Generated

from field: string networkIPv4 = 3;

-

networkIPv6

networkIPv6: string

NetworkIPv6 is the IPv6 network of the Mesh.

+

networkIPv6

networkIPv6: string

NetworkIPv6 is the IPv6 network of the Mesh.

Generated

from field: string networkIPv6 = 4;

-

peers

peers: WireGuardPeer[]

Peers is a list of wireguard peers to connect to.

+

peers

peers: WireGuardPeer[]

Peers is a list of wireguard peers to connect to.

Generated

from field: repeated v1.WireGuardPeer peers = 5;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.JoinResponse" = "v1.JoinResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.JoinResponse" = "v1.JoinResponse"

Methods

clone

  • Create a deep copy.

    Returns JoinResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -74,4 +74,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.LeaveRequest.html b/docs/classes/v1_members_pb.LeaveRequest.html index 03420eeb..472b9aa5 100644 --- a/docs/classes/v1_members_pb.LeaveRequest.html +++ b/docs/classes/v1_members_pb.LeaveRequest.html @@ -1,6 +1,6 @@ LeaveRequest | Webmesh API

Class LeaveRequest

LeaveRequest is a request to leave the cluster.

Generated

from message v1.LeaveRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the ID of the node.

+

Constructors

constructor

Properties

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LeaveRequest" = "v1.LeaveRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LeaveRequest" = "v1.LeaveRequest"

Methods

clone

  • Create a deep copy.

    Returns LeaveRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.LeaveResponse.html b/docs/classes/v1_members_pb.LeaveResponse.html index cd7d79ed..ee675f67 100644 --- a/docs/classes/v1_members_pb.LeaveResponse.html +++ b/docs/classes/v1_members_pb.LeaveResponse.html @@ -1,6 +1,6 @@ LeaveResponse | Webmesh API

Class LeaveResponse

LeaveResponse is a response to a leave request. It is currently empty.

Generated

from message v1.LeaveResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LeaveResponse" = "v1.LeaveResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LeaveResponse" = "v1.LeaveResponse"

Methods

clone

  • Create a deep copy.

    Returns LeaveResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.PeerConfigurations.html b/docs/classes/v1_members_pb.PeerConfigurations.html index 4bc1a468..fae9fafd 100644 --- a/docs/classes/v1_members_pb.PeerConfigurations.html +++ b/docs/classes/v1_members_pb.PeerConfigurations.html @@ -1,6 +1,6 @@ PeerConfigurations | Webmesh API

Class PeerConfigurations

PeerConfigurations is a stream of peer configurations.

Generated

from message v1.PeerConfigurations

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

dnsServers iceServers peers @@ -21,15 +21,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

dnsServers

dnsServers: string[]

DNSServers is a list of peers offering DNS services.

+

Constructors

constructor

Properties

dnsServers

dnsServers: string[]

DNSServers is a list of peers offering DNS services.

Generated

from field: repeated string dnsServers = 7;

-

iceServers

iceServers: string[]

ICEServers is a list of public nodes that can be used to negotiate +

iceServers

iceServers: string[]

ICEServers is a list of public nodes that can be used to negotiate ICE connections if required. This may only be populated when one of the peers has the ICE flag set.

Generated

from field: repeated string iceServers = 6;

-

peers

peers: WireGuardPeer[]

Peers is a list of wireguard peers to connect to.

+

peers

peers: WireGuardPeer[]

Peers is a list of wireguard peers to connect to.

Generated

from field: repeated v1.WireGuardPeer peers = 5;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PeerConfigurations" = "v1.PeerConfigurations"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PeerConfigurations" = "v1.PeerConfigurations"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -56,4 +56,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.StorageConsensusRequest.html b/docs/classes/v1_members_pb.StorageConsensusRequest.html index 3a96b19f..b91d4d05 100644 --- a/docs/classes/v1_members_pb.StorageConsensusRequest.html +++ b/docs/classes/v1_members_pb.StorageConsensusRequest.html @@ -1,6 +1,6 @@ StorageConsensusRequest | Webmesh API

Class StorageConsensusRequest

StorageConsensusRequest is a request to get the current Storage configuration.

Generated

from message v1.StorageConsensusRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageConsensusRequest" = "v1.StorageConsensusRequest"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageConsensusRequest" = "v1.StorageConsensusRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.StorageConsensusResponse.html b/docs/classes/v1_members_pb.StorageConsensusResponse.html index e5db8de1..60ea7f31 100644 --- a/docs/classes/v1_members_pb.StorageConsensusResponse.html +++ b/docs/classes/v1_members_pb.StorageConsensusResponse.html @@ -1,6 +1,6 @@ StorageConsensusResponse | Webmesh API

Class StorageConsensusResponse

StorageConsensusResponse is a response to a Storage consensus request.

Generated

from message v1.StorageConsensusResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

servers fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

servers

servers: StorageServer[]

Servers is the list of servers in the storage configuration.

+

Constructors

constructor

Properties

servers

servers: StorageServer[]

Servers is the list of servers in the storage configuration.

Generated

from field: repeated v1.StorageServer servers = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageConsensusResponse" = "v1.StorageConsensusResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageConsensusResponse" = "v1.StorageConsensusResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.StorageServer.html b/docs/classes/v1_members_pb.StorageServer.html index b7b09980..42a53c1a 100644 --- a/docs/classes/v1_members_pb.StorageServer.html +++ b/docs/classes/v1_members_pb.StorageServer.html @@ -1,6 +1,6 @@ StorageServer | Webmesh API

Class StorageServer

StorageServer is a server in the Storage configuration.

Generated

from message v1.StorageServer

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

address id publicKey @@ -22,15 +22,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

address

address: string

Address is the mesh address of the server.

+

Constructors

constructor

Properties

address

address: string

Address is the mesh address of the server.

Generated

from field: string address = 4;

-

id

id: string

ID is the ID of the server.

+

id

id: string

ID is the ID of the server.

Generated

from field: string id = 1;

-

publicKey

publicKey: string

PublicKey is the public key of this server. Not all storage providers track this field.

+

publicKey

publicKey: string

PublicKey is the public key of this server. Not all storage providers track this field.

Generated

from field: string publicKey = 3;

-

suffrage

suffrage: ClusterStatus

Suffrage is the suffrage of the server.

+

suffrage

suffrage: ClusterStatus

Suffrage is the suffrage of the server.

Generated

from field: v1.ClusterStatus suffrage = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageServer" = "v1.StorageServer"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageServer" = "v1.StorageServer"

Methods

clone

  • Create a deep copy.

    Returns StorageServer

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -57,4 +57,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.SubscribePeersRequest.html b/docs/classes/v1_members_pb.SubscribePeersRequest.html index bee4e735..7a966f4d 100644 --- a/docs/classes/v1_members_pb.SubscribePeersRequest.html +++ b/docs/classes/v1_members_pb.SubscribePeersRequest.html @@ -1,6 +1,6 @@ SubscribePeersRequest | Webmesh API

Class SubscribePeersRequest

SubscribePeersRequest is a request to subscribe to peer updates.

Generated

from message v1.SubscribePeersRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the ID of the node.

+

Constructors

constructor

Properties

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscribePeersRequest" = "v1.SubscribePeersRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscribePeersRequest" = "v1.SubscribePeersRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.UpdateRequest.html b/docs/classes/v1_members_pb.UpdateRequest.html index f8b29c24..4a47222d 100644 --- a/docs/classes/v1_members_pb.UpdateRequest.html +++ b/docs/classes/v1_members_pb.UpdateRequest.html @@ -1,7 +1,7 @@ UpdateRequest | Webmesh API

Class UpdateRequest

UpdateRequest contains most of the same fields as JoinRequest, but is used to update the state of a node in the cluster.

Generated

from message v1.UpdateRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

asVoter features id @@ -28,29 +28,29 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

asVoter

asVoter: boolean

AsVoter is whether the node should receive a vote in elections. The request +

Constructors

constructor

Properties

asVoter

asVoter: boolean

AsVoter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.

Generated

from field: bool asVoter = 6;

-

features

features: FeaturePort[]

Features is a list of features supported by the node that should be advertised to peers +

features

features: FeaturePort[]

Features is a list of features supported by the node that should be advertised to peers and the port they are available on.

Generated

from field: repeated v1.FeaturePort features = 8;

-

id

id: string

ID is the ID of the node.

+

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

multiaddrs

multiaddrs: string[]

Multiaddrs are libp2p multiaddresses this node is listening on.

+

multiaddrs

multiaddrs: string[]

Multiaddrs are libp2p multiaddresses this node is listening on.

Generated

from field: repeated string multiaddrs = 9;

-

primaryEndpoint

primaryEndpoint: string

PrimaryEndpoint is a routable address for the node. If left unset, +

primaryEndpoint

primaryEndpoint: string

PrimaryEndpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.

Generated

from field: string primaryEndpoint = 3;

-

publicKey

publicKey: string

PublicKey is the public key of the node to broadcast to peers.

+

publicKey

publicKey: string

PublicKey is the public key of the node to broadcast to peers.

Generated

from field: string publicKey = 2;

-

routes

routes: string[]

Routes is a list of routes to advertise to peers. The request will be denied +

routes

routes: string[]

Routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.

Generated

from field: repeated string routes = 7;

-

wireguardEndpoints

wireguardEndpoints: string[]

WireguardEndpoints is a list of WireGuard endpoints for the node.

+

wireguardEndpoints

wireguardEndpoints: string[]

WireguardEndpoints is a list of WireGuard endpoints for the node.

Generated

from field: repeated string wireguardEndpoints = 4;

-

zoneAwarenessID

zoneAwarenessID: string

ZoneAwarenessID is the zone awareness ID of the node.

+

zoneAwarenessID

zoneAwarenessID: string

ZoneAwarenessID is the zone awareness ID of the node.

Generated

from field: string zoneAwarenessID = 5;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.UpdateRequest" = "v1.UpdateRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.UpdateRequest" = "v1.UpdateRequest"

Methods

clone

  • Create a deep copy.

    Returns UpdateRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -77,4 +77,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.UpdateResponse.html b/docs/classes/v1_members_pb.UpdateResponse.html index fe798e5b..b7ab7d55 100644 --- a/docs/classes/v1_members_pb.UpdateResponse.html +++ b/docs/classes/v1_members_pb.UpdateResponse.html @@ -1,6 +1,6 @@ UpdateResponse | Webmesh API

Class UpdateResponse

UpdateResponse is a response to an update request. It is currently empty.

Generated

from message v1.UpdateResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.UpdateResponse" = "v1.UpdateResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.UpdateResponse" = "v1.UpdateResponse"

Methods

clone

  • Create a deep copy.

    Returns UpdateResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_members_pb.WireGuardPeer.html b/docs/classes/v1_members_pb.WireGuardPeer.html index 94974aca..6305f6f5 100644 --- a/docs/classes/v1_members_pb.WireGuardPeer.html +++ b/docs/classes/v1_members_pb.WireGuardPeer.html @@ -1,6 +1,6 @@ WireGuardPeer | Webmesh API

Class WireGuardPeer

WireGuardPeer is a peer in the Wireguard network.

Generated

from message v1.WireGuardPeer

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

allowedIPs allowedRoutes node? @@ -22,15 +22,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

allowedIPs

allowedIPs: string[]

AllowedIPs is the list of allowed IPs for the peer.

+

Constructors

constructor

Properties

allowedIPs

allowedIPs: string[]

AllowedIPs is the list of allowed IPs for the peer.

Generated

from field: repeated string allowedIPs = 2;

-

allowedRoutes

allowedRoutes: string[]

AllowedRoutes is the list of allowed routes for the peer.

+

allowedRoutes

allowedRoutes: string[]

AllowedRoutes is the list of allowed routes for the peer.

Generated

from field: repeated string allowedRoutes = 3;

-

Optional node

node?: MeshNode

Node is information about this node.

+

Optional node

node?: MeshNode

Node is information about this node.

Generated

from field: v1.MeshNode node = 1;

-

proto

proto: ConnectProtocol

Proto indicates the protocol to use to connect to the peer.

+

proto

proto: ConnectProtocol

Proto indicates the protocol to use to connect to the peer.

Generated

from field: v1.ConnectProtocol proto = 4;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.WireGuardPeer" = "v1.WireGuardPeer"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.WireGuardPeer" = "v1.WireGuardPeer"

Methods

clone

  • Create a deep copy.

    Returns WireGuardPeer

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -57,4 +57,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_mesh_pb.GetNodeRequest.html b/docs/classes/v1_mesh_pb.GetNodeRequest.html index 00a6cf53..21495247 100644 --- a/docs/classes/v1_mesh_pb.GetNodeRequest.html +++ b/docs/classes/v1_mesh_pb.GetNodeRequest.html @@ -1,6 +1,6 @@ GetNodeRequest | Webmesh API

Class GetNodeRequest

GetNodeRequest is a request to get a node.

Generated

from message v1.GetNodeRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the ID of the node.

+

Constructors

constructor

Properties

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetNodeRequest" = "v1.GetNodeRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetNodeRequest" = "v1.GetNodeRequest"

Methods

clone

  • Create a deep copy.

    Returns GetNodeRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_mesh_pb.MeshEdge.html b/docs/classes/v1_mesh_pb.MeshEdge.html index 05babf7c..92b66428 100644 --- a/docs/classes/v1_mesh_pb.MeshEdge.html +++ b/docs/classes/v1_mesh_pb.MeshEdge.html @@ -1,6 +1,6 @@ MeshEdge | Webmesh API

Class MeshEdge

MeshEdge is an edge between two nodes.

Generated

from message v1.MeshEdge

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

attributes source target @@ -22,15 +22,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

attributes

attributes: {
    [key: string]: string;
}

Attributes is a list of attributes for the edge.

+

Constructors

constructor

Properties

attributes

attributes: {
    [key: string]: string;
}

Attributes is a list of attributes for the edge.

Type declaration

  • [key: string]: string

Generated

from field: map<string, string> attributes = 4;

-

source

source: string

Source is the source node.

+

source

source: string

Source is the source node.

Generated

from field: string source = 1;

-

target

target: string

Target is the target node.

+

target

target: string

Target is the target node.

Generated

from field: string target = 2;

-

weight

weight: number

Weight is the weight of the edge.

+

weight

weight: number

Weight is the weight of the edge.

Generated

from field: int32 weight = 3;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshEdge" = "v1.MeshEdge"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshEdge" = "v1.MeshEdge"

Methods

clone

  • Create a deep copy.

    Returns MeshEdge

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -57,4 +57,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_mesh_pb.MeshEdges.html b/docs/classes/v1_mesh_pb.MeshEdges.html index 1d793273..3be67842 100644 --- a/docs/classes/v1_mesh_pb.MeshEdges.html +++ b/docs/classes/v1_mesh_pb.MeshEdges.html @@ -1,6 +1,6 @@ MeshEdges | Webmesh API

Class MeshEdges

MeshEdges is a list of edges.

Generated

from message v1.MeshEdges

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

items fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

items

items: MeshEdge[]

Items is the list of edges.

+

Constructors

constructor

Properties

items

items: MeshEdge[]

Items is the list of edges.

Generated

from field: repeated v1.MeshEdge items = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshEdges" = "v1.MeshEdges"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshEdges" = "v1.MeshEdges"

Methods

clone

  • Create a deep copy.

    Returns MeshEdges

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_mesh_pb.MeshGraph.html b/docs/classes/v1_mesh_pb.MeshGraph.html index 323074d5..99f532fc 100644 --- a/docs/classes/v1_mesh_pb.MeshGraph.html +++ b/docs/classes/v1_mesh_pb.MeshGraph.html @@ -1,6 +1,6 @@ MeshGraph | Webmesh API

Class MeshGraph

MeshGraph is a graph of nodes.

Generated

from message v1.MeshGraph

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

dot edges nodes @@ -21,13 +21,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

dot

dot: string

DOT is the DOT representation of the graph.

+

Constructors

constructor

Properties

dot

dot: string

DOT is the DOT representation of the graph.

Generated

from field: string dot = 3;

-

edges

edges: MeshEdge[]

Edges is the list of edges.

+

edges

edges: MeshEdge[]

Edges is the list of edges.

Generated

from field: repeated v1.MeshEdge edges = 2;

-

nodes

nodes: string[]

Nodes is the list of nodes.

+

nodes

nodes: string[]

Nodes is the list of nodes.

Generated

from field: repeated string nodes = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshGraph" = "v1.MeshGraph"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshGraph" = "v1.MeshGraph"

Methods

clone

  • Create a deep copy.

    Returns MeshGraph

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -54,4 +54,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_network_acls_pb.NetworkACL.html b/docs/classes/v1_network_acls_pb.NetworkACL.html index 897d2887..2417b0ad 100644 --- a/docs/classes/v1_network_acls_pb.NetworkACL.html +++ b/docs/classes/v1_network_acls_pb.NetworkACL.html @@ -1,6 +1,6 @@ NetworkACL | Webmesh API

Class NetworkACL

NetworkACL is a network ACL.

Generated

from message v1.NetworkACL

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

action destinationCIDRs destinationNodes @@ -25,25 +25,25 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

action

action: ACLAction

Action is the action to take when a request matches the ACL.

+

Constructors

constructor

Properties

action

action: ACLAction

Action is the action to take when a request matches the ACL.

Generated

from field: v1.ACLAction action = 3;

-

destinationCIDRs

destinationCIDRs: string[]

DestinationCIDRs is a list of destination CIDRs to match against. If empty, all CIDRs are matched. +

destinationCIDRs

destinationCIDRs: string[]

DestinationCIDRs is a list of destination CIDRs to match against. If empty, all CIDRs are matched. If one or more of the CIDRs is '*', all CIDRs are matched.

Generated

from field: repeated string destinationCIDRs = 7;

-

destinationNodes

destinationNodes: string[]

DestinationNodes is a list of destination nodes to match against. If empty, all nodes are matched. +

destinationNodes

destinationNodes: string[]

DestinationNodes is a list of destination nodes to match against. If empty, all nodes are matched. Groups can be specified with the prefix "group:". If one or more of the nodes is '*', all nodes are matched.

Generated

from field: repeated string destinationNodes = 5;

-

name

name: string

Name is the name of the ACL.

+

name

name: string

Name is the name of the ACL.

Generated

from field: string name = 1;

-

priority

priority: number

Priority is the priority of the ACL. ACLs with higher priority are evaluated first.

+

priority

priority: number

Priority is the priority of the ACL. ACLs with higher priority are evaluated first.

Generated

from field: int32 priority = 2;

-

sourceCIDRs

sourceCIDRs: string[]

SourceCIDRs is a list of source CIDRs to match against. If empty, all CIDRs are matched. +

sourceCIDRs

sourceCIDRs: string[]

SourceCIDRs is a list of source CIDRs to match against. If empty, all CIDRs are matched. If one or more of the CIDRs is '*', all CIDRs are matched.

Generated

from field: repeated string sourceCIDRs = 6;

-

sourceNodes

sourceNodes: string[]

SourceNodes is a list of source nodes to match against. If empty, all nodes are matched. Groups +

sourceNodes

sourceNodes: string[]

SourceNodes is a list of source nodes to match against. If empty, all nodes are matched. Groups can be specified with the prefix "group:". If one or more of the nodes is '*', all nodes are matched.

Generated

from field: repeated string sourceNodes = 4;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkACL" = "v1.NetworkACL"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkACL" = "v1.NetworkACL"

Methods

clone

  • Create a deep copy.

    Returns NetworkACL

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -70,4 +70,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_network_acls_pb.NetworkACLs.html b/docs/classes/v1_network_acls_pb.NetworkACLs.html index cdaceee5..a071f22e 100644 --- a/docs/classes/v1_network_acls_pb.NetworkACLs.html +++ b/docs/classes/v1_network_acls_pb.NetworkACLs.html @@ -1,6 +1,6 @@ NetworkACLs | Webmesh API

Class NetworkACLs

NetworkACLs is a list of network ACLs.

Generated

from message v1.NetworkACLs

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

items fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

items

items: NetworkACL[]

Items is the list of network ACLs.

+

Constructors

constructor

Properties

items

items: NetworkACL[]

Items is the list of network ACLs.

Generated

from field: repeated v1.NetworkACL items = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkACLs" = "v1.NetworkACLs"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkACLs" = "v1.NetworkACLs"

Methods

clone

  • Create a deep copy.

    Returns NetworkACLs

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_network_acls_pb.NetworkAction.html b/docs/classes/v1_network_acls_pb.NetworkAction.html index c800281b..63deabc2 100644 --- a/docs/classes/v1_network_acls_pb.NetworkAction.html +++ b/docs/classes/v1_network_acls_pb.NetworkAction.html @@ -1,7 +1,7 @@ NetworkAction | Webmesh API

Class NetworkAction

NetworkAction is an action that can be performed on a network resource. It is used by implementations to evaluate network ACLs.

Generated

from message v1.NetworkAction

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

dstCIDR dstNode srcCIDR @@ -23,15 +23,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

dstCIDR

dstCIDR: string

DstCIDR is the destination CIDR of the action.

+

Constructors

constructor

Properties

dstCIDR

dstCIDR: string

DstCIDR is the destination CIDR of the action.

Generated

from field: string dstCIDR = 4;

-

dstNode

dstNode: string

DstNode is the destination node of the action.

+

dstNode

dstNode: string

DstNode is the destination node of the action.

Generated

from field: string dstNode = 3;

-

srcCIDR

srcCIDR: string

SrcCIDR is the source CIDR of the action.

+

srcCIDR

srcCIDR: string

SrcCIDR is the source CIDR of the action.

Generated

from field: string srcCIDR = 2;

-

srcNode

srcNode: string

SrcNode is the source node of the action.

+

srcNode

srcNode: string

SrcNode is the source node of the action.

Generated

from field: string srcNode = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkAction" = "v1.NetworkAction"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkAction" = "v1.NetworkAction"

Methods

clone

  • Create a deep copy.

    Returns NetworkAction

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -58,4 +58,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_network_acls_pb.Route.html b/docs/classes/v1_network_acls_pb.Route.html index efa19345..dc640067 100644 --- a/docs/classes/v1_network_acls_pb.Route.html +++ b/docs/classes/v1_network_acls_pb.Route.html @@ -1,6 +1,6 @@ Route | Webmesh API

Class Route

Route is a route that is broadcasted by one or more nodes.

Generated

from message v1.Route

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

destinationCIDRs name nextHopNode @@ -22,16 +22,16 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

destinationCIDRs

destinationCIDRs: string[]

DestinationCIDRs are the destination CIDRs of the route.

+

Constructors

constructor

Properties

destinationCIDRs

destinationCIDRs: string[]

DestinationCIDRs are the destination CIDRs of the route.

Generated

from field: repeated string destinationCIDRs = 3;

-

name

name: string

Name is the name of the route.

+

name

name: string

Name is the name of the route.

Generated

from field: string name = 1;

-

nextHopNode

nextHopNode: string

NextHopNode is an optional node that is used as the next hop for the route. +

nextHopNode

nextHopNode: string

NextHopNode is an optional node that is used as the next hop for the route. This field is not currentl used.

Generated

from field: string nextHopNode = 4;

-

node

node: string

Node is the node that broadcasts the route. A group can be specified with the prefix "group:".

+

node

node: string

Node is the node that broadcasts the route. A group can be specified with the prefix "group:".

Generated

from field: string node = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Route" = "v1.Route"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Route" = "v1.Route"

Methods

clone

  • Create a deep copy.

    Returns Route

equals

  • Compare with a message of the same type.

    Parameters

    • other: undefined | null | Route | PlainMessage<Route>

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -58,4 +58,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_network_acls_pb.Routes.html b/docs/classes/v1_network_acls_pb.Routes.html index a3198baf..6d8509c2 100644 --- a/docs/classes/v1_network_acls_pb.Routes.html +++ b/docs/classes/v1_network_acls_pb.Routes.html @@ -1,6 +1,6 @@ Routes | Webmesh API

Class Routes

Routes is a list of routes.

Generated

from message v1.Routes

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

items fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

items

items: Route[]

Items is the list of routes.

+

Constructors

constructor

Properties

items

items: Route[]

Items is the list of routes.

Generated

from field: repeated v1.Route items = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Routes" = "v1.Routes"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Routes" = "v1.Routes"

Methods

clone

  • Create a deep copy.

    Returns Routes

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.DataChannelNegotiation.html b/docs/classes/v1_node_pb.DataChannelNegotiation.html index 58de100b..0fc63faa 100644 --- a/docs/classes/v1_node_pb.DataChannelNegotiation.html +++ b/docs/classes/v1_node_pb.DataChannelNegotiation.html @@ -1,6 +1,6 @@ DataChannelNegotiation | Webmesh API

Class DataChannelNegotiation

DataChannelNegotiation is the message for communicating data channels to nodes.

Generated

from message v1.DataChannelNegotiation

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

answer candidate dst @@ -26,23 +26,23 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

answer

answer: string

Answer is the answer for the node to use as its remote description.

+

Constructors

constructor

Properties

answer

answer: string

Answer is the answer for the node to use as its remote description.

Generated

from field: string answer = 6;

-

candidate

candidate: string

Candidate is an ICE candidate.

+

candidate

candidate: string

Candidate is an ICE candidate.

Generated

from field: string candidate = 7;

-

dst

dst: string

Dst is the destination address of the traffic.

+

dst

dst: string

Dst is the destination address of the traffic.

Generated

from field: string dst = 3;

-

offer

offer: string

Offer is the offer for the node to use as its local description.

+

offer

offer: string

Offer is the offer for the node to use as its local description.

Generated

from field: string offer = 5;

-

port

port: number

Port is the destination port of the traffic.

+

port

port: number

Port is the destination port of the traffic.

Generated

from field: uint32 port = 4;

-

proto

proto: string

Proto is the protocol of the traffic.

+

proto

proto: string

Proto is the protocol of the traffic.

Generated

from field: string proto = 1;

-

src

src: string

Src is the address of the client that initiated the request.

+

src

src: string

Src is the address of the client that initiated the request.

Generated

from field: string src = 2;

-

stunServers

stunServers: string[]

StunServers is the list of STUN servers to use.

+

stunServers

stunServers: string[]

StunServers is the list of STUN servers to use.

Generated

from field: repeated string stunServers = 8;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DataChannelNegotiation" = "v1.DataChannelNegotiation"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DataChannelNegotiation" = "v1.DataChannelNegotiation"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -69,4 +69,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.FeaturePort.html b/docs/classes/v1_node_pb.FeaturePort.html index d0f9fa77..51d4b61d 100644 --- a/docs/classes/v1_node_pb.FeaturePort.html +++ b/docs/classes/v1_node_pb.FeaturePort.html @@ -1,6 +1,6 @@ FeaturePort | Webmesh API

Class FeaturePort

FeaturePort describes a feature and the port it is advertised on.

Generated

from message v1.FeaturePort

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

feature port fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

feature

feature: Feature

Feature is the feature advertised on the port.

+

Constructors

constructor

Properties

feature

feature: Feature

Feature is the feature advertised on the port.

Generated

from field: v1.Feature feature = 1;

-

port

port: number

Port is the port the feature is advertised on.

+

port

port: number

Port is the port the feature is advertised on.

Generated

from field: int32 port = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.FeaturePort" = "v1.FeaturePort"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.FeaturePort" = "v1.FeaturePort"

Methods

clone

  • Create a deep copy.

    Returns FeaturePort

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.GetStatusRequest.html b/docs/classes/v1_node_pb.GetStatusRequest.html index 21b99638..c8f27e6d 100644 --- a/docs/classes/v1_node_pb.GetStatusRequest.html +++ b/docs/classes/v1_node_pb.GetStatusRequest.html @@ -1,6 +1,6 @@ GetStatusRequest | Webmesh API

Class GetStatusRequest

GetStatusRequest is a request to get the status of a node.

Generated

from message v1.GetStatusRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the ID of the node. If unset, the status of the local node is returned.

+

Constructors

constructor

Properties

id

id: string

ID is the ID of the node. If unset, the status of the local node is returned.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetStatusRequest" = "v1.GetStatusRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetStatusRequest" = "v1.GetStatusRequest"

Methods

clone

  • Create a deep copy.

    Returns GetStatusRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.InterfaceMetrics.html b/docs/classes/v1_node_pb.InterfaceMetrics.html index a95cce51..c437f69f 100644 --- a/docs/classes/v1_node_pb.InterfaceMetrics.html +++ b/docs/classes/v1_node_pb.InterfaceMetrics.html @@ -1,6 +1,6 @@ InterfaceMetrics | Webmesh API

Class InterfaceMetrics

InterfaceMetrics is the metrics for the WireGuard interface on a node.

Generated

from message v1.InterfaceMetrics

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

addressV4 addressV6 deviceName @@ -28,27 +28,27 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

addressV4

addressV4: string

AddressV4 is the IPv4 address of the node.

+

Constructors

constructor

Properties

addressV4

addressV4: string

AddressV4 is the IPv4 address of the node.

Generated

from field: string addressV4 = 3;

-

addressV6

addressV6: string

AddressV6 is the IPv6 address of the node.

+

addressV6

addressV6: string

AddressV6 is the IPv6 address of the node.

Generated

from field: string addressV6 = 4;

-

deviceName

deviceName: string

DeviceName is the name of the device.

+

deviceName

deviceName: string

DeviceName is the name of the device.

Generated

from field: string deviceName = 1;

-

listenPort

listenPort: number

ListenPort is the port wireguard is listening on.

+

listenPort

listenPort: number

ListenPort is the port wireguard is listening on.

Generated

from field: int32 listenPort = 6;

-

numPeers

numPeers: number

NumPeers is the number of peers connected to the node.

+

numPeers

numPeers: number

NumPeers is the number of peers connected to the node.

Generated

from field: int32 numPeers = 9;

-

peers

peers: PeerMetrics[]

Peers are the per-peer statistics.

+

peers

peers: PeerMetrics[]

Peers are the per-peer statistics.

Generated

from field: repeated v1.PeerMetrics peers = 10;

-

publicKey

publicKey: string

PublicKey is the public key of the node.

+

publicKey

publicKey: string

PublicKey is the public key of the node.

Generated

from field: string publicKey = 2;

-

totalReceiveBytes

totalReceiveBytes: bigint

TotalReceiveBytes is the total number of bytes received.

+

totalReceiveBytes

totalReceiveBytes: bigint

TotalReceiveBytes is the total number of bytes received.

Generated

from field: uint64 totalReceiveBytes = 7;

-

totalTransmitBytes

totalTransmitBytes: bigint

TotalTransmitBytes is the total number of bytes transmitted.

+

totalTransmitBytes

totalTransmitBytes: bigint

TotalTransmitBytes is the total number of bytes transmitted.

Generated

from field: uint64 totalTransmitBytes = 8;

-

type

type: string

Type is the type of interface being used for wireguard.

+

type

type: string

Type is the type of interface being used for wireguard.

Generated

from field: string type = 5;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.InterfaceMetrics" = "v1.InterfaceMetrics"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.InterfaceMetrics" = "v1.InterfaceMetrics"

Methods

clone

  • Create a deep copy.

    Returns InterfaceMetrics

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -75,4 +75,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.MeshNode.html b/docs/classes/v1_node_pb.MeshNode.html index 4ccf38f5..ac672bc1 100644 --- a/docs/classes/v1_node_pb.MeshNode.html +++ b/docs/classes/v1_node_pb.MeshNode.html @@ -1,6 +1,6 @@ MeshNode | Webmesh API

Class MeshNode

MeshNode is a node that has been registered with the mesh.

Generated

from message v1.MeshNode

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

features id joinedAt? @@ -28,27 +28,27 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

features

features: FeaturePort[]

Features are a list of features and the ports they are advertised on.

+

Constructors

constructor

Properties

features

features: FeaturePort[]

Features are a list of features and the ports they are advertised on.

Generated

from field: repeated v1.FeaturePort features = 9;

-

id

id: string

ID is the ID of the node.

+

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

Optional joinedAt

joinedAt?: Timestamp

JoinedAt is the time the node joined the cluster.

+

Optional joinedAt

joinedAt?: Timestamp

JoinedAt is the time the node joined the cluster.

Generated

from field: google.protobuf.Timestamp joinedAt = 11;

-

multiaddrs

multiaddrs: string[]

Multiaddrs are the multiaddrs of the node.

+

multiaddrs

multiaddrs: string[]

Multiaddrs are the multiaddrs of the node.

Generated

from field: repeated string multiaddrs = 10;

-

primaryEndpoint

primaryEndpoint: string

PrimaryEndpoint is the primary endpoint of the node.

+

primaryEndpoint

primaryEndpoint: string

PrimaryEndpoint is the primary endpoint of the node.

Generated

from field: string primaryEndpoint = 4;

-

privateIPv4

privateIPv4: string

PrivateIPv4 is the private IPv4 address of the node.

+

privateIPv4

privateIPv4: string

PrivateIPv4 is the private IPv4 address of the node.

Generated

from field: string privateIPv4 = 7;

-

privateIPv6

privateIPv6: string

PrivateIPv6 is the private IPv6 address of the node.

+

privateIPv6

privateIPv6: string

PrivateIPv6 is the private IPv6 address of the node.

Generated

from field: string privateIPv6 = 8;

-

publicKey

publicKey: string

PublicKey is the public key of the node.

+

publicKey

publicKey: string

PublicKey is the public key of the node.

Generated

from field: string publicKey = 2;

-

wireguardEndpoints

wireguardEndpoints: string[]

WireguardEndpoints is a list of WireGuard endpoints for the node.

+

wireguardEndpoints

wireguardEndpoints: string[]

WireguardEndpoints is a list of WireGuard endpoints for the node.

Generated

from field: repeated string wireguardEndpoints = 5;

-

zoneAwarenessID

zoneAwarenessID: string

ZoneAwarenessID is the zone awareness ID of the node.

+

zoneAwarenessID

zoneAwarenessID: string

ZoneAwarenessID is the zone awareness ID of the node.

Generated

from field: string zoneAwarenessID = 6;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshNode" = "v1.MeshNode"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.MeshNode" = "v1.MeshNode"

Methods

clone

  • Create a deep copy.

    Returns MeshNode

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -75,4 +75,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.NodeList.html b/docs/classes/v1_node_pb.NodeList.html index fa6bd543..92cbb560 100644 --- a/docs/classes/v1_node_pb.NodeList.html +++ b/docs/classes/v1_node_pb.NodeList.html @@ -1,6 +1,6 @@ NodeList | Webmesh API

Class NodeList

NodeList is a list of nodes.

Generated

from message v1.NodeList

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

nodes fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

nodes

nodes: MeshNode[]

Nodes is the list of nodes.

+

Constructors

constructor

Properties

nodes

nodes: MeshNode[]

Nodes is the list of nodes.

Generated

from field: repeated v1.MeshNode nodes = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NodeList" = "v1.NodeList"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NodeList" = "v1.NodeList"

Methods

clone

  • Create a deep copy.

    Returns NodeList

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.PeerMetrics.html b/docs/classes/v1_node_pb.PeerMetrics.html index 7c55bfbf..048c3249 100644 --- a/docs/classes/v1_node_pb.PeerMetrics.html +++ b/docs/classes/v1_node_pb.PeerMetrics.html @@ -1,6 +1,6 @@ PeerMetrics | Webmesh API

Class PeerMetrics

PeerMetrics are the metrics for a node's peer.

Generated

from message v1.PeerMetrics

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

allowedIPs endpoint lastHandshakeTime @@ -26,23 +26,23 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

allowedIPs

allowedIPs: string[]

AllowedIPs is the list of allowed IPs for the peer.

+

Constructors

constructor

Properties

allowedIPs

allowedIPs: string[]

AllowedIPs is the list of allowed IPs for the peer.

Generated

from field: repeated string allowedIPs = 5;

-

endpoint

endpoint: string

Endpoint is the connected endpoint of the peer.

+

endpoint

endpoint: string

Endpoint is the connected endpoint of the peer.

Generated

from field: string endpoint = 2;

-

lastHandshakeTime

lastHandshakeTime: string

LastHandshakeTime is the last handshake time for the peer.

+

lastHandshakeTime

lastHandshakeTime: string

LastHandshakeTime is the last handshake time for the peer.

Generated

from field: string lastHandshakeTime = 4;

-

persistentKeepAlive

persistentKeepAlive: string

PersistentKeepAlive is the persistent keep alive interval for the peer.

+

persistentKeepAlive

persistentKeepAlive: string

PersistentKeepAlive is the persistent keep alive interval for the peer.

Generated

from field: string persistentKeepAlive = 3;

-

protocolVersion

protocolVersion: bigint

ProtocolVersion is the version of the wireguard protocol negotiated with the peer.

+

protocolVersion

protocolVersion: bigint

ProtocolVersion is the version of the wireguard protocol negotiated with the peer.

Generated

from field: int64 protocolVersion = 6;

-

publicKey

publicKey: string

PublicKey is the public key of the peer.

+

publicKey

publicKey: string

PublicKey is the public key of the peer.

Generated

from field: string publicKey = 1;

-

receiveBytes

receiveBytes: bigint

ReceiveBytes is the bytes received from the peer.

+

receiveBytes

receiveBytes: bigint

ReceiveBytes is the bytes received from the peer.

Generated

from field: uint64 receiveBytes = 7;

-

transmitBytes

transmitBytes: bigint

TransmitBytes is the bytes transmitted to the peer.

+

transmitBytes

transmitBytes: bigint

TransmitBytes is the bytes transmitted to the peer.

Generated

from field: uint64 transmitBytes = 8;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PeerMetrics" = "v1.PeerMetrics"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PeerMetrics" = "v1.PeerMetrics"

Methods

clone

  • Create a deep copy.

    Returns PeerMetrics

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -69,4 +69,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.Status.html b/docs/classes/v1_node_pb.Status.html index 3a77f2bb..faf5cd39 100644 --- a/docs/classes/v1_node_pb.Status.html +++ b/docs/classes/v1_node_pb.Status.html @@ -1,6 +1,6 @@ Status | Webmesh API

Class Status

Status represents the status of a node.

Generated

from message v1.Status

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

buildDate clusterStatus currentLeader @@ -29,30 +29,30 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

buildDate

buildDate: string

BuildDate is the build date of the node.

+

Constructors

constructor

Properties

buildDate

buildDate: string

BuildDate is the build date of the node.

Generated

from field: string buildDate = 5;

-

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the node in the cluster.

+

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the node in the cluster.

Generated

from field: v1.ClusterStatus clusterStatus = 9;

-

currentLeader

currentLeader: string

CurrentLeader is the current leader of the cluster.

+

currentLeader

currentLeader: string

CurrentLeader is the current leader of the cluster.

Generated

from field: string currentLeader = 10;

-

description

description: string

Description is an optional description provided +

description

description: string

Description is an optional description provided by the node.

Generated

from field: string description = 2;

-

features

features: FeaturePort[]

Features is the list of features currently enabled.

+

features

features: FeaturePort[]

Features is the list of features currently enabled.

Generated

from field: repeated v1.FeaturePort features = 8;

-

gitCommit

gitCommit: string

GitCommit is the git commit of the node.

+

gitCommit

gitCommit: string

GitCommit is the git commit of the node.

Generated

from field: string gitCommit = 4;

-

id

id: string

ID is the ID of the node.

+

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

Optional interfaceMetrics

interfaceMetrics?: InterfaceMetrics

InterfaceMetrics are the metrics for the node's interfaces.

+

Optional interfaceMetrics

interfaceMetrics?: InterfaceMetrics

InterfaceMetrics are the metrics for the node's interfaces.

Generated

from field: v1.InterfaceMetrics interfaceMetrics = 11;

-

Optional startedAt

startedAt?: Timestamp

StartedAt is the time the node started.

+

Optional startedAt

startedAt?: Timestamp

StartedAt is the time the node started.

Generated

from field: google.protobuf.Timestamp startedAt = 7;

-

uptime

uptime: string

Uptime is the uptime of the node.

+

uptime

uptime: string

Uptime is the uptime of the node.

Generated

from field: string uptime = 6;

-

version

version: string

Version is the version of the node.

+

version

version: string

Version is the version of the node.

Generated

from field: string version = 3;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Status" = "v1.Status"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Status" = "v1.Status"

Methods

clone

  • Create a deep copy.

    Returns Status

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -79,4 +79,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Status

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_node_pb.WebRTCSignal.html b/docs/classes/v1_node_pb.WebRTCSignal.html index 62005ef9..e48291fe 100644 --- a/docs/classes/v1_node_pb.WebRTCSignal.html +++ b/docs/classes/v1_node_pb.WebRTCSignal.html @@ -1,6 +1,6 @@ WebRTCSignal | Webmesh API

Class WebRTCSignal

WebRTCSignal is a signal sent to a remote peer over the WebRTC API.

Generated

from message v1.WebRTCSignal

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

candidate description nodeID @@ -21,16 +21,16 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

candidate

candidate: string

Candidate is an ICE candidate.

+

Constructors

constructor

Properties

candidate

candidate: string

Candidate is an ICE candidate.

Generated

from field: string candidate = 2;

-

description

description: string

Description is a session description.

+

description

description: string

Description is a session description.

Generated

from field: string description = 3;

-

nodeID

nodeID: string

NodeID is the ID of the node to send the signal to. +

nodeID

nodeID: string

NodeID is the ID of the node to send the signal to. This is set by the original sender. On the node that receives the ReceiveSignalChannel request, this will be set to the ID of the node that sent the request.

Generated

from field: string nodeID = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.WebRTCSignal" = "v1.WebRTCSignal"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.WebRTCSignal" = "v1.WebRTCSignal"

Methods

clone

  • Create a deep copy.

    Returns WebRTCSignal

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -57,4 +57,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.AllocateIPRequest.html b/docs/classes/v1_plugin_pb.AllocateIPRequest.html index 19b4a3e8..a1e9ce2c 100644 --- a/docs/classes/v1_plugin_pb.AllocateIPRequest.html +++ b/docs/classes/v1_plugin_pb.AllocateIPRequest.html @@ -1,6 +1,6 @@ AllocateIPRequest | Webmesh API

Class AllocateIPRequest

AllocateIPRequest is the message containing an IP allocation request.

Generated

from message v1.AllocateIPRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

nodeID subnet fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

nodeID

nodeID: string

NodeID is the node that the IP should be allocated for.

+

Constructors

constructor

Properties

nodeID

nodeID: string

NodeID is the node that the IP should be allocated for.

Generated

from field: string nodeID = 1;

-

subnet

subnet: string

Subnet is the subnet that the IP should be allocated from.

+

subnet

subnet: string

Subnet is the subnet that the IP should be allocated from.

Generated

from field: string subnet = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AllocateIPRequest" = "v1.AllocateIPRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AllocateIPRequest" = "v1.AllocateIPRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.AllocatedIP.html b/docs/classes/v1_plugin_pb.AllocatedIP.html index 2551f9ce..4a89245a 100644 --- a/docs/classes/v1_plugin_pb.AllocatedIP.html +++ b/docs/classes/v1_plugin_pb.AllocatedIP.html @@ -1,6 +1,6 @@ AllocatedIP | Webmesh API

Class AllocatedIP

AllocatedIP is the message containing an allocated IP.

Generated

from message v1.AllocatedIP

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

ip fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

ip

ip: string

IP is the allocated IP. It should be returned in CIDR notation.

+

Constructors

constructor

Properties

ip

ip: string

IP is the allocated IP. It should be returned in CIDR notation.

Generated

from field: string ip = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AllocatedIP" = "v1.AllocatedIP"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AllocatedIP" = "v1.AllocatedIP"

Methods

clone

  • Create a deep copy.

    Returns AllocatedIP

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.AuthenticationRequest.html b/docs/classes/v1_plugin_pb.AuthenticationRequest.html index 78798dd6..6745f22c 100644 --- a/docs/classes/v1_plugin_pb.AuthenticationRequest.html +++ b/docs/classes/v1_plugin_pb.AuthenticationRequest.html @@ -1,6 +1,6 @@ AuthenticationRequest | Webmesh API

Class AuthenticationRequest

AuthenticationRequest is the message containing an authentication request.

Generated

from message v1.AuthenticationRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

certificates headers fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

certificates

certificates: Uint8Array[]

Certificates are the DER encoded certificates of the request.

+

Constructors

constructor

Properties

certificates

certificates: Uint8Array[]

Certificates are the DER encoded certificates of the request.

Generated

from field: repeated bytes certificates = 2;

-

headers

headers: {
    [key: string]: string;
}

Headers are the headers of the request.

+

headers

headers: {
    [key: string]: string;
}

Headers are the headers of the request.

Type declaration

  • [key: string]: string

Generated

from field: map<string, string> headers = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AuthenticationRequest" = "v1.AuthenticationRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AuthenticationRequest" = "v1.AuthenticationRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.AuthenticationResponse.html b/docs/classes/v1_plugin_pb.AuthenticationResponse.html index 0ab70aa7..6c9826e3 100644 --- a/docs/classes/v1_plugin_pb.AuthenticationResponse.html +++ b/docs/classes/v1_plugin_pb.AuthenticationResponse.html @@ -1,6 +1,6 @@ AuthenticationResponse | Webmesh API

Class AuthenticationResponse

AuthenticationResponse is the message containing an authentication response.

Generated

from message v1.AuthenticationResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID is the id of the authenticated user.

+

Constructors

constructor

Properties

id

id: string

ID is the id of the authenticated user.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AuthenticationResponse" = "v1.AuthenticationResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AuthenticationResponse" = "v1.AuthenticationResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.Event.html b/docs/classes/v1_plugin_pb.Event.html index 2c4ac9a0..0d7842f1 100644 --- a/docs/classes/v1_plugin_pb.Event.html +++ b/docs/classes/v1_plugin_pb.Event.html @@ -1,6 +1,6 @@ Event | Webmesh API

Class Event

Event is the message containing a watch event.

Generated

from message v1.Event

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

event type fields @@ -20,13 +20,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

event

event: {
    case: "node";
    value: MeshNode;
} | {
    case: undefined;
    value?: undefined;
}

Event is the data of the watch event.

+

Constructors

constructor

Properties

event

event: {
    case: "node";
    value: MeshNode;
} | {
    case: undefined;
    value?: undefined;
}

Event is the data of the watch event.

Type declaration

  • case: "node"
  • value: MeshNode

    Node is the node that the event is about.

    Generated

    from field: v1.MeshNode node = 2;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof v1.Event.event

-

type

type: Event_WatchEvent

Type is the type of the watch event.

+

type

type: Event_WatchEvent

Type is the type of the watch event.

Generated

from field: v1.Event.WatchEvent type = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Event" = "v1.Event"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Event" = "v1.Event"

Methods

clone

  • Create a deep copy.

    Returns Event

equals

  • Compare with a message of the same type.

    Parameters

    • other: undefined | null | Event | PlainMessage<Event>

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -53,4 +53,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Event

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.NodeConfiguration.html b/docs/classes/v1_plugin_pb.NodeConfiguration.html index 92e27cea..9cdd1fd5 100644 --- a/docs/classes/v1_plugin_pb.NodeConfiguration.html +++ b/docs/classes/v1_plugin_pb.NodeConfiguration.html @@ -1,7 +1,7 @@ NodeConfiguration | Webmesh API

Class NodeConfiguration

NodeConfiguration is the message containing the configuration of the node and the network that it is a part of.

Generated

from message v1.NodeConfiguration

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

addressIPv4 addressIPv6 domain @@ -26,21 +26,21 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

addressIPv4

addressIPv4: string

AddressIPv4 is the IPv4 address of the node.

+

Constructors

constructor

Properties

addressIPv4

addressIPv4: string

AddressIPv4 is the IPv4 address of the node.

Generated

from field: string addressIPv4 = 4;

-

addressIPv6

addressIPv6: string

AddressIPv6 is the IPv6 address of the node.

+

addressIPv6

addressIPv6: string

AddressIPv6 is the IPv6 address of the node.

Generated

from field: string addressIPv6 = 5;

-

domain

domain: string

Domain is the domain of the network.

+

domain

domain: string

Domain is the domain of the network.

Generated

from field: string domain = 6;

-

id

id: string

ID is the ID of the node.

+

id

id: string

ID is the ID of the node.

Generated

from field: string id = 1;

-

networkIPv4

networkIPv4: string

NetworkIPv4 is the IPv4 network that the node is a part of.

+

networkIPv4

networkIPv4: string

NetworkIPv4 is the IPv4 network that the node is a part of.

Generated

from field: string networkIPv4 = 2;

-

networkIPv6

networkIPv6: string

NetworkIPv6 is the IPv6 network that the node is a part of.

+

networkIPv6

networkIPv6: string

NetworkIPv6 is the IPv6 network that the node is a part of.

Generated

from field: string networkIPv6 = 3;

-

privateKey

privateKey: Uint8Array

PrivateKey is the private key of the node.

+

privateKey

privateKey: Uint8Array

PrivateKey is the private key of the node.

Generated

from field: bytes privateKey = 7;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NodeConfiguration" = "v1.NodeConfiguration"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NodeConfiguration" = "v1.NodeConfiguration"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -67,4 +67,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.PluginConfiguration.html b/docs/classes/v1_plugin_pb.PluginConfiguration.html index 844e4251..2effa8e0 100644 --- a/docs/classes/v1_plugin_pb.PluginConfiguration.html +++ b/docs/classes/v1_plugin_pb.PluginConfiguration.html @@ -1,6 +1,6 @@ PluginConfiguration | Webmesh API

Class PluginConfiguration

PluginConfiguration is the message containing the configuration of a plugin.

Generated

from message v1.PluginConfiguration

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

config? nodeConfig? fields @@ -20,12 +20,12 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Optional config

config?: Struct

Config is the configuration for the plugin. This will be specific +

Constructors

constructor

Properties

Optional config

config?: Struct

Config is the configuration for the plugin. This will be specific for each plugin.

Generated

from field: google.protobuf.Struct config = 1;

-

Optional nodeConfig

nodeConfig?: NodeConfiguration

NodeConfig is the configuration of the node and the network that it is a part of.

+

Optional nodeConfig

nodeConfig?: NodeConfiguration

NodeConfig is the configuration of the node and the network that it is a part of.

Generated

from field: v1.NodeConfiguration nodeConfig = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PluginConfiguration" = "v1.PluginConfiguration"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PluginConfiguration" = "v1.PluginConfiguration"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -52,4 +52,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.PluginInfo.html b/docs/classes/v1_plugin_pb.PluginInfo.html index e6666d4e..056695f7 100644 --- a/docs/classes/v1_plugin_pb.PluginInfo.html +++ b/docs/classes/v1_plugin_pb.PluginInfo.html @@ -1,6 +1,6 @@ PluginInfo | Webmesh API

Class PluginInfo

PluginInfo is the information of a plugin.

Generated

from message v1.PluginInfo

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

capabilities description name @@ -22,15 +22,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

capabilities

capabilities: PluginInfo_PluginCapability[]

Capabilities is the capabilities of the plugin.

+

Constructors

constructor

Properties

capabilities

capabilities: PluginInfo_PluginCapability[]

Capabilities is the capabilities of the plugin.

Generated

from field: repeated v1.PluginInfo.PluginCapability capabilities = 5;

-

description

description: string

Description is the description of the plugin.

+

description

description: string

Description is the description of the plugin.

Generated

from field: string description = 3;

-

name

name: string

Name is the name of the plugin.

+

name

name: string

Name is the name of the plugin.

Generated

from field: string name = 1;

-

version

version: string

Version is the version of the plugin.

+

version

version: string

Version is the version of the plugin.

Generated

from field: string version = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PluginInfo" = "v1.PluginInfo"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PluginInfo" = "v1.PluginInfo"

Methods

clone

  • Create a deep copy.

    Returns PluginInfo

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -57,4 +57,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_plugin_pb.ReleaseIPRequest.html b/docs/classes/v1_plugin_pb.ReleaseIPRequest.html index d1cc6fd8..48ed7a7c 100644 --- a/docs/classes/v1_plugin_pb.ReleaseIPRequest.html +++ b/docs/classes/v1_plugin_pb.ReleaseIPRequest.html @@ -1,6 +1,6 @@ ReleaseIPRequest | Webmesh API

Class ReleaseIPRequest

ReleaseIPRequest is the message containing an IP release request.

Generated

from message v1.ReleaseIPRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

ip nodeID fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

ip

ip: string

IP is the IP that should be released.

+

Constructors

constructor

Properties

ip

ip: string

IP is the IP that should be released.

Generated

from field: string ip = 2;

-

nodeID

nodeID: string

NodeID is the node that the IP should be released for.

+

nodeID

nodeID: string

NodeID is the node that the IP should be released for.

Generated

from field: string nodeID = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ReleaseIPRequest" = "v1.ReleaseIPRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ReleaseIPRequest" = "v1.ReleaseIPRequest"

Methods

clone

  • Create a deep copy.

    Returns ReleaseIPRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_raft_pb.RaftApplyResponse.html b/docs/classes/v1_raft_pb.RaftApplyResponse.html index 7d5e6b33..db4dba1c 100644 --- a/docs/classes/v1_raft_pb.RaftApplyResponse.html +++ b/docs/classes/v1_raft_pb.RaftApplyResponse.html @@ -1,7 +1,7 @@ RaftApplyResponse | Webmesh API

Class RaftApplyResponse

RaftApplyResponse is the response to an apply request. It contains the result of applying the log entry.

Generated

from message v1.RaftApplyResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

error time fields @@ -21,11 +21,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

error

error: string

Error is an error that occurred during the apply.

+

Constructors

constructor

Properties

error

error: string

Error is an error that occurred during the apply.

Generated

from field: string error = 2;

-

time

time: string

Time is the total time it took to apply the log entry.

+

time

time: string

Time is the total time it took to apply the log entry.

Generated

from field: string time = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftApplyResponse" = "v1.RaftApplyResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftApplyResponse" = "v1.RaftApplyResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -52,4 +52,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_raft_pb.RaftDataItem.html b/docs/classes/v1_raft_pb.RaftDataItem.html index c509d8a3..8f9e40fd 100644 --- a/docs/classes/v1_raft_pb.RaftDataItem.html +++ b/docs/classes/v1_raft_pb.RaftDataItem.html @@ -1,6 +1,6 @@ RaftDataItem | Webmesh API

Class RaftDataItem

RaftDataItem represents a value in the Raft data store.

Generated

from message v1.RaftDataItem

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

key ttl? value @@ -21,13 +21,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the data item.

+

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the data item.

Generated

from field: bytes key = 1;

-

Optional ttl

ttl?: Duration

TTL is the time to live of the data item.

+

Optional ttl

ttl?: Duration

TTL is the time to live of the data item.

Generated

from field: google.protobuf.Duration ttl = 3;

-

value

value: Uint8Array

Value is the value of the data item.

+

value

value: Uint8Array

Value is the value of the data item.

Generated

from field: bytes value = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftDataItem" = "v1.RaftDataItem"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftDataItem" = "v1.RaftDataItem"

Methods

clone

  • Create a deep copy.

    Returns RaftDataItem

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -54,4 +54,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_raft_pb.RaftLogEntry.html b/docs/classes/v1_raft_pb.RaftLogEntry.html index 00c8f52e..bcef39c8 100644 --- a/docs/classes/v1_raft_pb.RaftLogEntry.html +++ b/docs/classes/v1_raft_pb.RaftLogEntry.html @@ -1,6 +1,6 @@ RaftLogEntry | Webmesh API

Class RaftLogEntry

RaftLogEntry is the data of an entry in the Raft log.

Generated

from message v1.RaftLogEntry

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

key ttl? type @@ -22,15 +22,15 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the log entry.

+

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the log entry.

Generated

from field: bytes key = 2;

-

Optional ttl

ttl?: Duration

TTL is the time to live of the log entry.

+

Optional ttl

ttl?: Duration

TTL is the time to live of the log entry.

Generated

from field: google.protobuf.Duration ttl = 4;

-

type

type: RaftCommandType

Type is the type of the log entry.

+

type

type: RaftCommandType

Type is the type of the log entry.

Generated

from field: v1.RaftCommandType type = 1;

-

value

value: Uint8Array

Value is the value of the log entry.

+

value

value: Uint8Array

Value is the value of the log entry.

Generated

from field: bytes value = 3;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftLogEntry" = "v1.RaftLogEntry"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftLogEntry" = "v1.RaftLogEntry"

Methods

clone

  • Create a deep copy.

    Returns RaftLogEntry

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -57,4 +57,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_raft_pb.RaftSnapshot.html b/docs/classes/v1_raft_pb.RaftSnapshot.html index a944bcd7..c556d9e9 100644 --- a/docs/classes/v1_raft_pb.RaftSnapshot.html +++ b/docs/classes/v1_raft_pb.RaftSnapshot.html @@ -1,6 +1,6 @@ RaftSnapshot | Webmesh API

Class RaftSnapshot

RaftSnapshot is the data of a snapshot.

Generated

from message v1.RaftSnapshot

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

kv fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

kv

kv: RaftDataItem[]

KV is the key/value pairs of the snapshot.

+

Constructors

constructor

Properties

kv

kv: RaftDataItem[]

KV is the key/value pairs of the snapshot.

Generated

from field: repeated v1.RaftDataItem kv = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftSnapshot" = "v1.RaftSnapshot"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RaftSnapshot" = "v1.RaftSnapshot"

Methods

clone

  • Create a deep copy.

    Returns RaftSnapshot

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.Group.html b/docs/classes/v1_rbac_pb.Group.html index c32c461f..120cbcc5 100644 --- a/docs/classes/v1_rbac_pb.Group.html +++ b/docs/classes/v1_rbac_pb.Group.html @@ -1,6 +1,6 @@ Group | Webmesh API

Class Group

Group is a group of subjects.

Generated

from message v1.Group

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

name subjects fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

name

name: string

Name is the name of the group.

+

Constructors

constructor

Properties

name

name: string

Name is the name of the group.

Generated

from field: string name = 1;

-

subjects

subjects: Subject[]

Subjects is the list of subjects in the group.

+

subjects

subjects: Subject[]

Subjects is the list of subjects in the group.

Generated

from field: repeated v1.Subject subjects = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Group" = "v1.Group"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Group" = "v1.Group"

Methods

clone

  • Create a deep copy.

    Returns Group

equals

  • Compare with a message of the same type.

    Parameters

    • other: undefined | null | Group | PlainMessage<Group>

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Group

Static fromJson

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns Group

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Group

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.Groups.html b/docs/classes/v1_rbac_pb.Groups.html index cedebbb0..caae80a6 100644 --- a/docs/classes/v1_rbac_pb.Groups.html +++ b/docs/classes/v1_rbac_pb.Groups.html @@ -1,6 +1,6 @@ Groups | Webmesh API

Class Groups

Groups is a list of groups.

Generated

from message v1.Groups

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

items fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

items

items: Group[]

Items is the list of groups.

+

Constructors

constructor

Properties

items

items: Group[]

Items is the list of groups.

Generated

from field: repeated v1.Group items = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Groups" = "v1.Groups"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Groups" = "v1.Groups"

Methods

clone

  • Create a deep copy.

    Returns Groups

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Groups

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.RBACAction.html b/docs/classes/v1_rbac_pb.RBACAction.html index 98edeb5f..cebbe817 100644 --- a/docs/classes/v1_rbac_pb.RBACAction.html +++ b/docs/classes/v1_rbac_pb.RBACAction.html @@ -1,7 +1,7 @@ RBACAction | Webmesh API

Class RBACAction

RBACAction is an action that can be performed on a resource. It is used by implementations to evaluate rules.

Generated

from message v1.RBACAction

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

resource resourceName verb @@ -22,14 +22,14 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

resource

resource: RuleResource

Resource is the resource on which the action is performed.

+

Constructors

constructor

Properties

resource

resource: RuleResource

Resource is the resource on which the action is performed.

Generated

from field: v1.RuleResource resource = 1;

-

resourceName

resourceName: string

ResourceName is the name of the resource on which the action is +

resourceName

resourceName: string

ResourceName is the name of the resource on which the action is performed.

Generated

from field: string resourceName = 2;

-

verb

verb: RuleVerb

Verb is the verb that is performed on the resource.

+

verb

verb: RuleVerb

Verb is the verb that is performed on the resource.

Generated

from field: v1.RuleVerb verb = 3;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RBACAction" = "v1.RBACAction"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RBACAction" = "v1.RBACAction"

Methods

clone

  • Create a deep copy.

    Returns RBACAction

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -56,4 +56,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.Role.html b/docs/classes/v1_rbac_pb.Role.html index 1df70467..9c934da5 100644 --- a/docs/classes/v1_rbac_pb.Role.html +++ b/docs/classes/v1_rbac_pb.Role.html @@ -1,6 +1,6 @@ Role | Webmesh API

Class Role

Role is a role that can be assigned to a subject.

Generated

from message v1.Role

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

name rules fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

name

name: string

Name is the name of the role.

+

Constructors

constructor

Properties

name

name: string

Name is the name of the role.

Generated

from field: string name = 1;

-

rules

rules: Rule[]

Rules is the list of rules that apply to the role.

+

rules

rules: Rule[]

Rules is the list of rules that apply to the role.

Generated

from field: repeated v1.Rule rules = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Role" = "v1.Role"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Role" = "v1.Role"

Methods

clone

  • Create a deep copy.

    Returns Role

equals

  • Compare with a message of the same type.

    Parameters

    • other: undefined | null | Role | PlainMessage<Role>

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Role

Static fromJson

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns Role

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Role

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.RoleBinding.html b/docs/classes/v1_rbac_pb.RoleBinding.html index a5a1db36..06ef5c3c 100644 --- a/docs/classes/v1_rbac_pb.RoleBinding.html +++ b/docs/classes/v1_rbac_pb.RoleBinding.html @@ -1,6 +1,6 @@ RoleBinding | Webmesh API

Class RoleBinding

RoleBinding is a binding of a role to one or more subjects.

Generated

from message v1.RoleBinding

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

name role subjects @@ -21,13 +21,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

name

name: string

Name is the name of the role binding.

+

Constructors

constructor

Properties

name

name: string

Name is the name of the role binding.

Generated

from field: string name = 1;

-

role

role: string

Role is the name of the role to which the binding applies.

+

role

role: string

Role is the name of the role to which the binding applies.

Generated

from field: string role = 2;

-

subjects

subjects: Subject[]

Subjects is the list of subjects to which the binding applies.

+

subjects

subjects: Subject[]

Subjects is the list of subjects to which the binding applies.

Generated

from field: repeated v1.Subject subjects = 3;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RoleBinding" = "v1.RoleBinding"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RoleBinding" = "v1.RoleBinding"

Methods

clone

  • Create a deep copy.

    Returns RoleBinding

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -54,4 +54,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.RoleBindings.html b/docs/classes/v1_rbac_pb.RoleBindings.html index bb0ed6a4..690a65f6 100644 --- a/docs/classes/v1_rbac_pb.RoleBindings.html +++ b/docs/classes/v1_rbac_pb.RoleBindings.html @@ -1,6 +1,6 @@ RoleBindings | Webmesh API

Class RoleBindings

RoleBindings is a list of role bindings.

Generated

from message v1.RoleBindings

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

items fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

items

items: RoleBinding[]

Items is the list of role bindings.

+

Constructors

constructor

Properties

items

items: RoleBinding[]

Items is the list of role bindings.

Generated

from field: repeated v1.RoleBinding items = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RoleBindings" = "v1.RoleBindings"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RoleBindings" = "v1.RoleBindings"

Methods

clone

  • Create a deep copy.

    Returns RoleBindings

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.Roles.html b/docs/classes/v1_rbac_pb.Roles.html index 0e0356a9..aa8e5ad6 100644 --- a/docs/classes/v1_rbac_pb.Roles.html +++ b/docs/classes/v1_rbac_pb.Roles.html @@ -1,6 +1,6 @@ Roles | Webmesh API

Class Roles

Roles is a list of roles.

Generated

from message v1.Roles

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

items fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

items

items: Role[]

Items is the list of roles.

+

Constructors

constructor

Properties

items

items: Role[]

Items is the list of roles.

Generated

from field: repeated v1.Role items = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Roles" = "v1.Roles"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Roles" = "v1.Roles"

Methods

clone

  • Create a deep copy.

    Returns Roles

equals

  • Compare with a message of the same type.

    Parameters

    • other: undefined | null | Roles | PlainMessage<Roles>

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Roles

Static fromJson

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns Roles

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Roles

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.Rule.html b/docs/classes/v1_rbac_pb.Rule.html index 9314d97e..fb04cf68 100644 --- a/docs/classes/v1_rbac_pb.Rule.html +++ b/docs/classes/v1_rbac_pb.Rule.html @@ -1,6 +1,6 @@ Rule | Webmesh API

Class Rule

Rule is a rule that applies to a resource.

Generated

from message v1.Rule

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

resourceNames resources verbs @@ -21,13 +21,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

resourceNames

resourceNames: string[]

ResourceNames is the list of resource names to which the rule applies.

+

Constructors

constructor

Properties

resourceNames

resourceNames: string[]

ResourceNames is the list of resource names to which the rule applies.

Generated

from field: repeated string resourceNames = 2;

-

resources

resources: RuleResource[]

Resources is the resources to which the rule applies.

+

resources

resources: RuleResource[]

Resources is the resources to which the rule applies.

Generated

from field: repeated v1.RuleResource resources = 1;

-

verbs

verbs: RuleVerb[]

Verbs is the list of verbs that apply to the resource.

+

verbs

verbs: RuleVerb[]

Verbs is the list of verbs that apply to the resource.

Generated

from field: repeated v1.RuleVerb verbs = 3;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Rule" = "v1.Rule"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Rule" = "v1.Rule"

Methods

clone

  • Create a deep copy.

    Returns Rule

equals

  • Compare with a message of the same type.

    Parameters

    • other: undefined | null | Rule | PlainMessage<Rule>

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -54,4 +54,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Rule

Static fromJson

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns Rule

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Rule

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_rbac_pb.Subject.html b/docs/classes/v1_rbac_pb.Subject.html index 2f071623..2a8d79a6 100644 --- a/docs/classes/v1_rbac_pb.Subject.html +++ b/docs/classes/v1_rbac_pb.Subject.html @@ -1,6 +1,6 @@ Subject | Webmesh API

Class Subject

Subject is a subject to which a role can be bound.

Generated

from message v1.Subject

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

name type fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

name

name: string

Name is the name of the subject.

+

Constructors

constructor

Properties

name

name: string

Name is the name of the subject.

Generated

from field: string name = 1;

-

type

type: SubjectType

Type is the type of the subject.

+

type

type: SubjectType

Type is the type of the subject.

Generated

from field: v1.SubjectType type = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Subject" = "v1.Subject"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.Subject" = "v1.Subject"

Methods

clone

  • Create a deep copy.

    Returns Subject

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_registrar_pb.LookupRequest.html b/docs/classes/v1_registrar_pb.LookupRequest.html index 7dc06320..198d5eeb 100644 --- a/docs/classes/v1_registrar_pb.LookupRequest.html +++ b/docs/classes/v1_registrar_pb.LookupRequest.html @@ -1,7 +1,7 @@ LookupRequest | Webmesh API

Class LookupRequest

LookupRequest is the request object for the Lookup RPC. One of the fields must be provided.

Generated

from message v1.LookupRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

alias id publicKey @@ -22,13 +22,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

alias

alias: string

The alias of the public key to lookup.

+

Constructors

constructor

Properties

alias

alias: string

The alias of the public key to lookup.

Generated

from field: string alias = 3;

-

id

id: string

The ID derived from the public key to lookup.

+

id

id: string

The ID derived from the public key to lookup.

Generated

from field: string id = 1;

-

publicKey

publicKey: string

The public key to lookup.

+

publicKey

publicKey: string

The public key to lookup.

Generated

from field: string publicKey = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LookupRequest" = "v1.LookupRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LookupRequest" = "v1.LookupRequest"

Methods

clone

  • Create a deep copy.

    Returns LookupRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -55,4 +55,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_registrar_pb.LookupResponse.html b/docs/classes/v1_registrar_pb.LookupResponse.html index f42dea4e..fef62d65 100644 --- a/docs/classes/v1_registrar_pb.LookupResponse.html +++ b/docs/classes/v1_registrar_pb.LookupResponse.html @@ -1,6 +1,6 @@ LookupResponse | Webmesh API

Class LookupResponse

LookupResponse is the response object for the Lookup RPC.

Generated

from message v1.LookupResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

alias id publicKey @@ -21,13 +21,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

alias

alias: string

Any alias associated with the public key.

+

Constructors

constructor

Properties

alias

alias: string

Any alias associated with the public key.

Generated

from field: string alias = 3;

-

id

id: string

The ID of the public key that was looked up.

+

id

id: string

The ID of the public key that was looked up.

Generated

from field: string id = 1;

-

publicKey

publicKey: string

The encoded public key that was looked up.

+

publicKey

publicKey: string

The encoded public key that was looked up.

Generated

from field: string publicKey = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LookupResponse" = "v1.LookupResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.LookupResponse" = "v1.LookupResponse"

Methods

clone

  • Create a deep copy.

    Returns LookupResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -54,4 +54,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_registrar_pb.RegisterRequest.html b/docs/classes/v1_registrar_pb.RegisterRequest.html index 65ba45a8..8715ae97 100644 --- a/docs/classes/v1_registrar_pb.RegisterRequest.html +++ b/docs/classes/v1_registrar_pb.RegisterRequest.html @@ -1,6 +1,6 @@ RegisterRequest | Webmesh API

Class RegisterRequest

RegisterRequest is the request object for the Register RPC.

Generated

from message v1.RegisterRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

alias expiry? publicKey @@ -21,16 +21,16 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

alias

alias: string

An alias to associate with the public key. This can be used to lookup +

Constructors

constructor

Properties

alias

alias: string

An alias to associate with the public key. This can be used to lookup the public key later.

Generated

from field: string alias = 2;

-

Optional expiry

expiry?: Timestamp

Expiry is the time at which the public key and its associated aliases +

Optional expiry

expiry?: Timestamp

Expiry is the time at which the public key and its associated aliases should be removed from the registrar. If not provided, a default value of 1 day from the time of registration will be used.

Generated

from field: google.protobuf.Timestamp expiry = 3;

-

publicKey

publicKey: string

The encoded public key to register.

+

publicKey

publicKey: string

The encoded public key to register.

Generated

from field: string publicKey = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RegisterRequest" = "v1.RegisterRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RegisterRequest" = "v1.RegisterRequest"

Methods

clone

  • Create a deep copy.

    Returns RegisterRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -57,4 +57,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_registrar_pb.RegisterResponse.html b/docs/classes/v1_registrar_pb.RegisterResponse.html index b24495c0..2d66597a 100644 --- a/docs/classes/v1_registrar_pb.RegisterResponse.html +++ b/docs/classes/v1_registrar_pb.RegisterResponse.html @@ -1,6 +1,6 @@ RegisterResponse | Webmesh API

Class RegisterResponse

RegisterResponse is the response object for the Register RPC.

Generated

from message v1.RegisterResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

id fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

id

id: string

ID of the public key that was registered.

+

Constructors

constructor

Properties

id

id: string

ID of the public key that was registered.

Generated

from field: string id = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RegisterResponse" = "v1.RegisterResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RegisterResponse" = "v1.RegisterResponse"

Methods

clone

  • Create a deep copy.

    Returns RegisterResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.AddObserverResponse.html b/docs/classes/v1_storage_provider_pb.AddObserverResponse.html index 7070b063..3400fcfb 100644 --- a/docs/classes/v1_storage_provider_pb.AddObserverResponse.html +++ b/docs/classes/v1_storage_provider_pb.AddObserverResponse.html @@ -1,6 +1,6 @@ AddObserverResponse | Webmesh API

Class AddObserverResponse

AddObserverResponse is the response object for the AddObserver RPC.

Generated

from message v1.AddObserverResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AddObserverResponse" = "v1.AddObserverResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AddObserverResponse" = "v1.AddObserverResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.AddVoterResponse.html b/docs/classes/v1_storage_provider_pb.AddVoterResponse.html index 8a58f25a..298b4b51 100644 --- a/docs/classes/v1_storage_provider_pb.AddVoterResponse.html +++ b/docs/classes/v1_storage_provider_pb.AddVoterResponse.html @@ -1,6 +1,6 @@ AddVoterResponse | Webmesh API

Class AddVoterResponse

AddVoterResponse is the response object for the AddVoter RPC.

Generated

from message v1.AddVoterResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AddVoterResponse" = "v1.AddVoterResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.AddVoterResponse" = "v1.AddVoterResponse"

Methods

clone

  • Create a deep copy.

    Returns AddVoterResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.BootstrapRequest.html b/docs/classes/v1_storage_provider_pb.BootstrapRequest.html index cb5e489e..1fbe6a50 100644 --- a/docs/classes/v1_storage_provider_pb.BootstrapRequest.html +++ b/docs/classes/v1_storage_provider_pb.BootstrapRequest.html @@ -1,6 +1,6 @@ BootstrapRequest | Webmesh API

Class BootstrapRequest

BootstrapRequest is the request object for the Bootstrap RPC.

Generated

from message v1.BootstrapRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.BootstrapRequest" = "v1.BootstrapRequest"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.BootstrapRequest" = "v1.BootstrapRequest"

Methods

clone

  • Create a deep copy.

    Returns BootstrapRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.BootstrapResponse.html b/docs/classes/v1_storage_provider_pb.BootstrapResponse.html index 01a8abb5..0c099f69 100644 --- a/docs/classes/v1_storage_provider_pb.BootstrapResponse.html +++ b/docs/classes/v1_storage_provider_pb.BootstrapResponse.html @@ -1,6 +1,6 @@ BootstrapResponse | Webmesh API

Class BootstrapResponse

BootstrapResponse is the response object for the Bootstrap RPC.

Generated

from message v1.BootstrapResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

status? fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Optional status

status?: StorageStatus

Status is the status of the storage after the bootstrap.

+

Constructors

constructor

Properties

Optional status

status?: StorageStatus

Status is the status of the storage after the bootstrap.

Generated

from field: v1.StorageStatus status = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.BootstrapResponse" = "v1.BootstrapResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.BootstrapResponse" = "v1.BootstrapResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.DeleteValueRequest.html b/docs/classes/v1_storage_provider_pb.DeleteValueRequest.html index cff4f3ac..135d3f4d 100644 --- a/docs/classes/v1_storage_provider_pb.DeleteValueRequest.html +++ b/docs/classes/v1_storage_provider_pb.DeleteValueRequest.html @@ -1,6 +1,6 @@ DeleteValueRequest | Webmesh API

Class DeleteValueRequest

DeleteValueRequest is the request object for the DeleteValue RPC.

Generated

from message v1.DeleteValueRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

key fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key to delete.

+

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key to delete.

Generated

from field: bytes key = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DeleteValueRequest" = "v1.DeleteValueRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DeleteValueRequest" = "v1.DeleteValueRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.DeleteValueResponse.html b/docs/classes/v1_storage_provider_pb.DeleteValueResponse.html index 0a305a97..eb00031c 100644 --- a/docs/classes/v1_storage_provider_pb.DeleteValueResponse.html +++ b/docs/classes/v1_storage_provider_pb.DeleteValueResponse.html @@ -1,6 +1,6 @@ DeleteValueResponse | Webmesh API

Class DeleteValueResponse

DeleteValueResponse is the response object for the DeleteValue RPC.

Generated

from message v1.DeleteValueResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DeleteValueResponse" = "v1.DeleteValueResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DeleteValueResponse" = "v1.DeleteValueResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.DemoteVoterResponse.html b/docs/classes/v1_storage_provider_pb.DemoteVoterResponse.html index 5001d64e..8f6c5826 100644 --- a/docs/classes/v1_storage_provider_pb.DemoteVoterResponse.html +++ b/docs/classes/v1_storage_provider_pb.DemoteVoterResponse.html @@ -1,6 +1,6 @@ DemoteVoterResponse | Webmesh API

Class DemoteVoterResponse

DemoteVoterResponse is the response object for the DemoteVoter RPC.

Generated

from message v1.DemoteVoterResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DemoteVoterResponse" = "v1.DemoteVoterResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DemoteVoterResponse" = "v1.DemoteVoterResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.GetLeaderRequest.html b/docs/classes/v1_storage_provider_pb.GetLeaderRequest.html index 0f0b32eb..2a3a95e9 100644 --- a/docs/classes/v1_storage_provider_pb.GetLeaderRequest.html +++ b/docs/classes/v1_storage_provider_pb.GetLeaderRequest.html @@ -1,6 +1,6 @@ GetLeaderRequest | Webmesh API

Class GetLeaderRequest

GetLeaderRequest is the request object for the GetLeader RPC.

Generated

from message v1.GetLeaderRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetLeaderRequest" = "v1.GetLeaderRequest"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetLeaderRequest" = "v1.GetLeaderRequest"

Methods

clone

  • Create a deep copy.

    Returns GetLeaderRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.GetPeersRequest.html b/docs/classes/v1_storage_provider_pb.GetPeersRequest.html index e9eeec02..dcf3f2dd 100644 --- a/docs/classes/v1_storage_provider_pb.GetPeersRequest.html +++ b/docs/classes/v1_storage_provider_pb.GetPeersRequest.html @@ -1,6 +1,6 @@ GetPeersRequest | Webmesh API

Class GetPeersRequest

GetPeersRequest is the request object for the GetPeers RPC.

Generated

from message v1.GetPeersRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetPeersRequest" = "v1.GetPeersRequest"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetPeersRequest" = "v1.GetPeersRequest"

Methods

clone

  • Create a deep copy.

    Returns GetPeersRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.GetValueRequest.html b/docs/classes/v1_storage_provider_pb.GetValueRequest.html index e3a7aba4..9e47b4e4 100644 --- a/docs/classes/v1_storage_provider_pb.GetValueRequest.html +++ b/docs/classes/v1_storage_provider_pb.GetValueRequest.html @@ -1,6 +1,6 @@ GetValueRequest | Webmesh API

Class GetValueRequest

GetValueRequest is the request object for the GetValue RPC.

Generated

from message v1.GetValueRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

key fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key to get the value for.

+

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key to get the value for.

Generated

from field: bytes key = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetValueRequest" = "v1.GetValueRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetValueRequest" = "v1.GetValueRequest"

Methods

clone

  • Create a deep copy.

    Returns GetValueRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.GetValueResponse.html b/docs/classes/v1_storage_provider_pb.GetValueResponse.html index b448fcd3..5a2516cd 100644 --- a/docs/classes/v1_storage_provider_pb.GetValueResponse.html +++ b/docs/classes/v1_storage_provider_pb.GetValueResponse.html @@ -1,6 +1,6 @@ GetValueResponse | Webmesh API

Class GetValueResponse

GetValueResponse is the response object for the GetValue RPC.

Generated

from message v1.GetValueResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

value? fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Optional value

value?: StorageValue

Value is the value of the key.

+

Constructors

constructor

Properties

Optional value

value?: StorageValue

Value is the value of the key.

Generated

from field: v1.StorageValue value = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetValueResponse" = "v1.GetValueResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.GetValueResponse" = "v1.GetValueResponse"

Methods

clone

  • Create a deep copy.

    Returns GetValueResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.ListKeysRequest.html b/docs/classes/v1_storage_provider_pb.ListKeysRequest.html index 34c9b618..08c29582 100644 --- a/docs/classes/v1_storage_provider_pb.ListKeysRequest.html +++ b/docs/classes/v1_storage_provider_pb.ListKeysRequest.html @@ -1,6 +1,6 @@ ListKeysRequest | Webmesh API

Class ListKeysRequest

ListKeysRequest is the request object for the ListValues RPC.

Generated

from message v1.ListKeysRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

prefix fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to list values for.

+

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to list values for.

Generated

from field: bytes prefix = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListKeysRequest" = "v1.ListKeysRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListKeysRequest" = "v1.ListKeysRequest"

Methods

clone

  • Create a deep copy.

    Returns ListKeysRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.ListKeysResponse.html b/docs/classes/v1_storage_provider_pb.ListKeysResponse.html index bb52037c..787011f1 100644 --- a/docs/classes/v1_storage_provider_pb.ListKeysResponse.html +++ b/docs/classes/v1_storage_provider_pb.ListKeysResponse.html @@ -1,6 +1,6 @@ ListKeysResponse | Webmesh API

Class ListKeysResponse

ListKeysResponse is the response object for the ListValues RPC.

Generated

from message v1.ListKeysResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

keys fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

keys

keys: Uint8Array[]

Keys is the list of value keys for the prefix.

+

Constructors

constructor

Properties

keys

keys: Uint8Array[]

Keys is the list of value keys for the prefix.

Generated

from field: repeated bytes keys = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListKeysResponse" = "v1.ListKeysResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListKeysResponse" = "v1.ListKeysResponse"

Methods

clone

  • Create a deep copy.

    Returns ListKeysResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.ListValuesRequest.html b/docs/classes/v1_storage_provider_pb.ListValuesRequest.html index b83306ac..b21e7552 100644 --- a/docs/classes/v1_storage_provider_pb.ListValuesRequest.html +++ b/docs/classes/v1_storage_provider_pb.ListValuesRequest.html @@ -1,6 +1,6 @@ ListValuesRequest | Webmesh API

Class ListValuesRequest

ListValuesRequest is the request object for the ListValues RPC.

Generated

from message v1.ListValuesRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

prefix fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to list values for.

+

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to list values for.

Generated

from field: bytes prefix = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListValuesRequest" = "v1.ListValuesRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListValuesRequest" = "v1.ListValuesRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.ListValuesResponse.html b/docs/classes/v1_storage_provider_pb.ListValuesResponse.html index 432a8f09..0a36d85b 100644 --- a/docs/classes/v1_storage_provider_pb.ListValuesResponse.html +++ b/docs/classes/v1_storage_provider_pb.ListValuesResponse.html @@ -1,6 +1,6 @@ ListValuesResponse | Webmesh API

Class ListValuesResponse

ListValuesResponse is the response object for the ListValues RPC.

Generated

from message v1.ListValuesResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

values fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

values

values: StorageValue[]

Values is the list of values for the prefix.

+

Constructors

constructor

Properties

values

values: StorageValue[]

Values is the list of values for the prefix.

Generated

from field: repeated v1.StorageValue values = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListValuesResponse" = "v1.ListValuesResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.ListValuesResponse" = "v1.ListValuesResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.PrefixEvent.html b/docs/classes/v1_storage_provider_pb.PrefixEvent.html index d14b0a1f..6d32f86b 100644 --- a/docs/classes/v1_storage_provider_pb.PrefixEvent.html +++ b/docs/classes/v1_storage_provider_pb.PrefixEvent.html @@ -1,7 +1,7 @@ PrefixEvent | Webmesh API

Class PrefixEvent

PrefixEvent is an event that is emitted when a value is added or removed from the storage for a prefix.

Generated

from message v1.PrefixEvent

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

eventType prefix value? @@ -22,13 +22,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

eventType

eventType: PrefixEvent_EventType

EventType is the type of event.

+

Constructors

constructor

Properties

eventType

eventType: PrefixEvent_EventType

EventType is the type of event.

Generated

from field: v1.PrefixEvent.EventType eventType = 3;

-

prefix

prefix: Uint8Array

Prefix is the prefix that the event is for.

+

prefix

prefix: Uint8Array

Prefix is the prefix that the event is for.

Generated

from field: bytes prefix = 1;

-

Optional value

value?: StorageValue

Value is the value that was added or removed.

+

Optional value

value?: StorageValue

Value is the value that was added or removed.

Generated

from field: v1.StorageValue value = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PrefixEvent" = "v1.PrefixEvent"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PrefixEvent" = "v1.PrefixEvent"

Methods

clone

  • Create a deep copy.

    Returns PrefixEvent

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -55,4 +55,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.PutValueRequest.html b/docs/classes/v1_storage_provider_pb.PutValueRequest.html index 8bdcaf5d..4b08d1dd 100644 --- a/docs/classes/v1_storage_provider_pb.PutValueRequest.html +++ b/docs/classes/v1_storage_provider_pb.PutValueRequest.html @@ -1,6 +1,6 @@ PutValueRequest | Webmesh API

Class PutValueRequest

PutValueRequest is the request object for the PutValue RPC.

Generated

from message v1.PutValueRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

ttl? value? fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Optional ttl

ttl?: Duration

TTL is the time to live for the value.

+

Constructors

constructor

Properties

Optional ttl

ttl?: Duration

TTL is the time to live for the value.

Generated

from field: google.protobuf.Duration ttl = 2;

-

Optional value

value?: StorageValue

Value is the value to put.

+

Optional value

value?: StorageValue

Value is the value to put.

Generated

from field: v1.StorageValue value = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PutValueRequest" = "v1.PutValueRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PutValueRequest" = "v1.PutValueRequest"

Methods

clone

  • Create a deep copy.

    Returns PutValueRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.PutValueResponse.html b/docs/classes/v1_storage_provider_pb.PutValueResponse.html index b77de31c..e71c616a 100644 --- a/docs/classes/v1_storage_provider_pb.PutValueResponse.html +++ b/docs/classes/v1_storage_provider_pb.PutValueResponse.html @@ -1,6 +1,6 @@ PutValueResponse | Webmesh API

Class PutValueResponse

PutValueResponse is the response object for the PutValue RPC.

Generated

from message v1.PutValueResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PutValueResponse" = "v1.PutValueResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PutValueResponse" = "v1.PutValueResponse"

Methods

clone

  • Create a deep copy.

    Returns PutValueResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.RemoveServerResponse.html b/docs/classes/v1_storage_provider_pb.RemoveServerResponse.html index 2475c719..aa1e2d73 100644 --- a/docs/classes/v1_storage_provider_pb.RemoveServerResponse.html +++ b/docs/classes/v1_storage_provider_pb.RemoveServerResponse.html @@ -1,6 +1,6 @@ RemoveServerResponse | Webmesh API

Class RemoveServerResponse

RemoveServerResponse is the response object for the RemoveServer RPC.

Generated

from message v1.RemoveServerResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RemoveServerResponse" = "v1.RemoveServerResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.RemoveServerResponse" = "v1.RemoveServerResponse"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.StoragePeer.html b/docs/classes/v1_storage_provider_pb.StoragePeer.html index 8562d5cf..c08c8ce5 100644 --- a/docs/classes/v1_storage_provider_pb.StoragePeer.html +++ b/docs/classes/v1_storage_provider_pb.StoragePeer.html @@ -1,6 +1,6 @@ StoragePeer | Webmesh API

Class StoragePeer

StoragePeer is a server that is currently recognized by the storage plugin.

Generated

from message v1.StoragePeer

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

address clusterStatus id @@ -22,18 +22,18 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

address

address: string

Address is the address of the server. This is not required +

Constructors

constructor

Properties

address

address: string

Address is the address of the server. This is not required for demotion or removal RPCs.

Generated

from field: string address = 3;

-

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the server. This is only +

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the server. This is only applicable during a GetStatus RPC.

Generated

from field: v1.ClusterStatus clusterStatus = 4;

-

id

id: string

ID is the id of the server.

+

id

id: string

ID is the id of the server.

Generated

from field: string id = 1;

-

publicKey

publicKey: string

PublicKey is the encoded public key of the server. This is not required +

publicKey

publicKey: string

PublicKey is the encoded public key of the server. This is not required for demotion or removal RPCs. Not all implementations need to support this.

Generated

from field: string publicKey = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StoragePeer" = "v1.StoragePeer"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StoragePeer" = "v1.StoragePeer"

Methods

clone

  • Create a deep copy.

    Returns StoragePeer

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -60,4 +60,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.StoragePeers.html b/docs/classes/v1_storage_provider_pb.StoragePeers.html index ba711469..3346fe1f 100644 --- a/docs/classes/v1_storage_provider_pb.StoragePeers.html +++ b/docs/classes/v1_storage_provider_pb.StoragePeers.html @@ -1,6 +1,6 @@ StoragePeers | Webmesh API

Class StoragePeers

StoragePeers is a list of servers that are currently recognized by the storage plugin.

Generated

from message v1.StoragePeers

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

peers fields runtime @@ -19,10 +19,10 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

peers

peers: StoragePeer[]

Peers is the list of servers that are currently recognized as peers +

Constructors

constructor

Properties

peers

peers: StoragePeer[]

Peers is the list of servers that are currently recognized as peers by the storage plugin.

Generated

from field: repeated v1.StoragePeer peers = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StoragePeers" = "v1.StoragePeers"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StoragePeers" = "v1.StoragePeers"

Methods

clone

  • Create a deep copy.

    Returns StoragePeers

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -49,4 +49,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.StorageStatus.html b/docs/classes/v1_storage_provider_pb.StorageStatus.html index ebbb1958..74324b23 100644 --- a/docs/classes/v1_storage_provider_pb.StorageStatus.html +++ b/docs/classes/v1_storage_provider_pb.StorageStatus.html @@ -1,6 +1,6 @@ StorageStatus | Webmesh API

Class StorageStatus

StorageStatus is the response object for the StorageStatus RPC.

Generated

from message v1.StorageStatus

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

clusterStatus isWritable message @@ -22,18 +22,18 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the storage. The definitions applied +

Constructors

constructor

Properties

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the storage. The definitions applied to each status are implementation specific.

Generated

from field: v1.ClusterStatus clusterStatus = 2;

-

isWritable

isWritable: boolean

IsWritable is true if the storage can currently be written to.

+

isWritable

isWritable: boolean

IsWritable is true if the storage can currently be written to.

Generated

from field: bool isWritable = 1;

-

message

message: string

Message is an implementation specific message that can be used to provide +

message

message: string

Message is an implementation specific message that can be used to provide additional information about the storage status.

Generated

from field: string message = 4;

-

peers

peers: StoragePeer[]

Peers is the list of servers that are currently recognized as peers +

peers

peers: StoragePeer[]

Peers is the list of servers that are currently recognized as peers by the storage plugin. This should include the current server.

Generated

from field: repeated v1.StoragePeer peers = 3;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageStatus" = "v1.StorageStatus"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageStatus" = "v1.StorageStatus"

Methods

clone

  • Create a deep copy.

    Returns StorageStatus

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -60,4 +60,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.StorageStatusRequest.html b/docs/classes/v1_storage_provider_pb.StorageStatusRequest.html index 8d2c73c1..97a9c1ed 100644 --- a/docs/classes/v1_storage_provider_pb.StorageStatusRequest.html +++ b/docs/classes/v1_storage_provider_pb.StorageStatusRequest.html @@ -1,6 +1,6 @@ StorageStatusRequest | Webmesh API

Class StorageStatusRequest

StorageStatusRequest is the request object for the StorageStatus RPC.

Generated

from message v1.StorageStatusRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -18,7 +18,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageStatusRequest" = "v1.StorageStatusRequest"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageStatusRequest" = "v1.StorageStatusRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -45,4 +45,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.StorageValue.html b/docs/classes/v1_storage_provider_pb.StorageValue.html index dbb609e2..3da369f7 100644 --- a/docs/classes/v1_storage_provider_pb.StorageValue.html +++ b/docs/classes/v1_storage_provider_pb.StorageValue.html @@ -1,6 +1,6 @@ StorageValue | Webmesh API

Class StorageValue

StorageValue is a value stored in the storage.

Generated

from message v1.StorageValue

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

key value fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the value.

+

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the value.

Generated

from field: bytes key = 1;

-

value

value: Uint8Array

Value is the value of the key.

+

value

value: Uint8Array

Value is the value of the key.

Generated

from field: bytes value = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageValue" = "v1.StorageValue"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StorageValue" = "v1.StorageValue"

Methods

clone

  • Create a deep copy.

    Returns StorageValue

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_provider_pb.SubscribePrefixRequest.html b/docs/classes/v1_storage_provider_pb.SubscribePrefixRequest.html index ea555c95..dd37d796 100644 --- a/docs/classes/v1_storage_provider_pb.SubscribePrefixRequest.html +++ b/docs/classes/v1_storage_provider_pb.SubscribePrefixRequest.html @@ -1,6 +1,6 @@ SubscribePrefixRequest | Webmesh API

Class SubscribePrefixRequest

SubscribePrefixRequest is the request object for the SubscribePrefix RPC.

Generated

from message v1.SubscribePrefixRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

prefix fields runtime @@ -19,9 +19,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to subscribe to.

+

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to subscribe to.

Generated

from field: bytes prefix = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscribePrefixRequest" = "v1.SubscribePrefixRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscribePrefixRequest" = "v1.SubscribePrefixRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -48,4 +48,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_query_pb.NetworkState.html b/docs/classes/v1_storage_query_pb.NetworkState.html index e7f96d83..e860361e 100644 --- a/docs/classes/v1_storage_query_pb.NetworkState.html +++ b/docs/classes/v1_storage_query_pb.NetworkState.html @@ -1,7 +1,7 @@ NetworkState | Webmesh API

Class NetworkState

NetworkState represents the full network state as returned by a network state query.

Generated

from message v1.NetworkState

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

domain networkV4 networkV6 @@ -22,10 +22,10 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

domain

domain: string

Generated

from field: string domain = 3;

-

networkV4

networkV4: string

Generated

from field: string networkV4 = 1;

-

networkV6

networkV6: string

Generated

from field: string networkV6 = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkState" = "v1.NetworkState"

Methods

clone

Constructors

constructor

Properties

domain

domain: string

Generated

from field: string domain = 3;

+

networkV4

networkV4: string

Generated

from field: string networkV4 = 1;

+

networkV6

networkV6: string

Generated

from field: string networkV6 = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.NetworkState" = "v1.NetworkState"

Methods

clone

  • Create a deep copy.

    Returns NetworkState

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -52,4 +52,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_query_pb.PublishRequest.html b/docs/classes/v1_storage_query_pb.PublishRequest.html index a63848d7..e3ac1669 100644 --- a/docs/classes/v1_storage_query_pb.PublishRequest.html +++ b/docs/classes/v1_storage_query_pb.PublishRequest.html @@ -1,7 +1,7 @@ PublishRequest | Webmesh API

Class PublishRequest

PublishRequest is sent by the application to the node to publish events. This currently only supports database events.

Generated

from message v1.PublishRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

key ttl? value @@ -22,13 +22,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the event.

+

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the event.

Generated

from field: bytes key = 1;

-

Optional ttl

ttl?: Duration

TTL is the time for the event to live in the database.

+

Optional ttl

ttl?: Duration

TTL is the time for the event to live in the database.

Generated

from field: google.protobuf.Duration ttl = 3;

-

value

value: Uint8Array

Value is the value of the event. This will be the raw value of the key.

+

value

value: Uint8Array

Value is the value of the event. This will be the raw value of the key.

Generated

from field: bytes value = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PublishRequest" = "v1.PublishRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PublishRequest" = "v1.PublishRequest"

Methods

clone

  • Create a deep copy.

    Returns PublishRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -55,4 +55,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_query_pb.PublishResponse.html b/docs/classes/v1_storage_query_pb.PublishResponse.html index 5d279d60..217c14bd 100644 --- a/docs/classes/v1_storage_query_pb.PublishResponse.html +++ b/docs/classes/v1_storage_query_pb.PublishResponse.html @@ -1,7 +1,7 @@ PublishResponse | Webmesh API

Class PublishResponse

PublishResponse is the response to a publish request. This is currently empty.

Generated

from message v1.PublishResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

fields runtime typeName @@ -19,7 +19,7 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PublishResponse" = "v1.PublishResponse"

Methods

clone

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.PublishResponse" = "v1.PublishResponse"

Methods

clone

  • Create a deep copy.

    Returns PublishResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -46,4 +46,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_query_pb.QueryRequest.html b/docs/classes/v1_storage_query_pb.QueryRequest.html index 0b9b2e38..0037b826 100644 --- a/docs/classes/v1_storage_query_pb.QueryRequest.html +++ b/docs/classes/v1_storage_query_pb.QueryRequest.html @@ -1,7 +1,7 @@ QueryRequest | Webmesh API

Class QueryRequest

QueryRequest is sent by the application to the node to query the mesh for information.

Generated

from message v1.QueryRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

command item query @@ -23,19 +23,19 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

command

command: QueryRequest_QueryCommand

Command is the command of the query.

+

Constructors

constructor

Properties

command

command: QueryRequest_QueryCommand

Command is the command of the query.

Generated

from field: v1.QueryRequest.QueryCommand command = 1;

-

item

item: Uint8Array

Item is an item to put. This is only applicable for PUT queries. It should be a +

item

item: Uint8Array

Item is an item to put. This is only applicable for PUT queries. It should be a protobuf-JSON encoded object of the given query type.

Generated

from field: bytes item = 4;

-

query

query: string

Query is the string of the query. This follows the format of a comma-separted +

query

query: string

Query is the string of the query. This follows the format of a comma-separted label selector and is only applicable for certain queries. For get queries this will usually be an ID. For list queries this will usually be one or more filters. On put or delete queries, this should be an ID.

Generated

from field: string query = 3;

-

type

type: QueryRequest_QueryType

Type is the type of resource for the query.

+

type

type: QueryRequest_QueryType

Type is the type of resource for the query.

Generated

from field: v1.QueryRequest.QueryType type = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.QueryRequest" = "v1.QueryRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.QueryRequest" = "v1.QueryRequest"

Methods

clone

  • Create a deep copy.

    Returns QueryRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -62,4 +62,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_query_pb.QueryResponse.html b/docs/classes/v1_storage_query_pb.QueryResponse.html index 45180934..23eafef6 100644 --- a/docs/classes/v1_storage_query_pb.QueryResponse.html +++ b/docs/classes/v1_storage_query_pb.QueryResponse.html @@ -1,6 +1,6 @@ QueryResponse | Webmesh API

Class QueryResponse

QueryResponse is the message containing a mesh query result.

Generated

from message v1.QueryResponse

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

error items fields @@ -20,14 +20,14 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

error

error: string

Error is an error that happened during the query. This will always +

Constructors

constructor

Properties

error

error: string

Error is an error that happened during the query. This will always be populated on errors, but single-flight queries will return a coded error instead.

Generated

from field: string error = 4;

-

items

items: Uint8Array[]

Items contain the results of the query. These will be protobuf +

items

items: Uint8Array[]

Items contain the results of the query. These will be protobuf json-encoded objects of the given query type.

Generated

from field: repeated bytes items = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.QueryResponse" = "v1.QueryResponse"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.QueryResponse" = "v1.QueryResponse"

Methods

clone

  • Create a deep copy.

    Returns QueryResponse

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -54,4 +54,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_query_pb.SubscribeRequest.html b/docs/classes/v1_storage_query_pb.SubscribeRequest.html index b99d907a..86fa412a 100644 --- a/docs/classes/v1_storage_query_pb.SubscribeRequest.html +++ b/docs/classes/v1_storage_query_pb.SubscribeRequest.html @@ -1,7 +1,7 @@ SubscribeRequest | Webmesh API

Class SubscribeRequest

SubscribeRequest is sent by the application to the node to subscribe to events. This currently only supports database events.

Generated

from message v1.SubscribeRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

prefix fields runtime @@ -20,9 +20,9 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix of the events to subscribe to.

+

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix of the events to subscribe to.

Generated

from field: bytes prefix = 1;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscribeRequest" = "v1.SubscribeRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscribeRequest" = "v1.SubscribeRequest"

Methods

clone

  • Create a deep copy.

    Returns SubscribeRequest

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -49,4 +49,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_storage_query_pb.SubscriptionEvent.html b/docs/classes/v1_storage_query_pb.SubscriptionEvent.html index 53c69ef2..a46e05db 100644 --- a/docs/classes/v1_storage_query_pb.SubscriptionEvent.html +++ b/docs/classes/v1_storage_query_pb.SubscriptionEvent.html @@ -1,6 +1,6 @@ SubscriptionEvent | Webmesh API

Class SubscriptionEvent

SubscriptionEvent is a message containing a subscription event.

Generated

from message v1.SubscriptionEvent

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

key value fields @@ -20,11 +20,11 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the event.

+

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the event.

Generated

from field: bytes key = 1;

-

value

value: Uint8Array

Value is the value of the event. This will be the raw value of the key.

+

value

value: Uint8Array

Value is the value of the event. This will be the raw value of the key.

Generated

from field: bytes value = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscriptionEvent" = "v1.SubscriptionEvent"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.SubscriptionEvent" = "v1.SubscriptionEvent"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -51,4 +51,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_webrtc_pb.DataChannelOffer.html b/docs/classes/v1_webrtc_pb.DataChannelOffer.html index 4f9e8702..c5f47cc4 100644 --- a/docs/classes/v1_webrtc_pb.DataChannelOffer.html +++ b/docs/classes/v1_webrtc_pb.DataChannelOffer.html @@ -1,7 +1,7 @@ DataChannelOffer | Webmesh API

Class DataChannelOffer

DataChannelOffer is an offer for a data channel. Candidates are sent after the offer is sent.

Generated

from message v1.DataChannelOffer

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

candidate offer stunServers @@ -22,13 +22,13 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

candidate

candidate: string

Candidate is an ICE candidate.

+

Constructors

constructor

Properties

candidate

candidate: string

Candidate is an ICE candidate.

Generated

from field: string candidate = 3;

-

offer

offer: string

Offer is the offer.

+

offer

offer: string

Offer is the offer.

Generated

from field: string offer = 1;

-

stunServers

stunServers: string[]

STUNServers is the list of STUN servers to use.

+

stunServers

stunServers: string[]

STUNServers is the list of STUN servers to use.

Generated

from field: repeated string stunServers = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DataChannelOffer" = "v1.DataChannelOffer"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.DataChannelOffer" = "v1.DataChannelOffer"

Methods

clone

  • Create a deep copy.

    Returns DataChannelOffer

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -55,4 +55,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/v1_webrtc_pb.StartDataChannelRequest.html b/docs/classes/v1_webrtc_pb.StartDataChannelRequest.html index 9ceb6aa8..9d7286f1 100644 --- a/docs/classes/v1_webrtc_pb.StartDataChannelRequest.html +++ b/docs/classes/v1_webrtc_pb.StartDataChannelRequest.html @@ -2,7 +2,7 @@ The answer and candidate fields are populated after the offer is received.

Generated

from message v1.StartDataChannelRequest

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

answer candidate dst @@ -26,20 +26,20 @@ fromBinary fromJson fromJsonString -

Constructors

constructor

Properties

answer

answer: string

Answer is the answer to the offer.

+

Constructors

constructor

Properties

answer

answer: string

Answer is the answer to the offer.

Generated

from field: string answer = 5;

-

candidate

candidate: string

Candidate is an ICE candidate.

+

candidate

candidate: string

Candidate is an ICE candidate.

Generated

from field: string candidate = 6;

-

dst

dst: string

Dst is the destination address of the traffic.

+

dst

dst: string

Dst is the destination address of the traffic.

Generated

from field: string dst = 3;

-

nodeID

nodeID: string

NodeID is the ID of the node to send the data to.

+

nodeID

nodeID: string

NodeID is the ID of the node to send the data to.

Generated

from field: string nodeID = 1;

-

port

port: number

Port is the destination port of the traffic. A port of 0 coupled +

port

port: number

Port is the destination port of the traffic. A port of 0 coupled with the udp protocol indicates forwarding to the WireGuard interface.

Generated

from field: uint32 port = 4;

-

proto

proto: string

Proto is the protocol of the traffic.

+

proto

proto: string

Proto is the protocol of the traffic.

Generated

from field: string proto = 2;

-

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StartDataChannelRequest" = "v1.StartDataChannelRequest"

Methods

clone

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "v1.StartDataChannelRequest" = "v1.StartDataChannelRequest"

Methods

clone

equals

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting @@ -66,4 +66,4 @@

    Returns JsonValue

toJson

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • Serialize the message to a JSON string.

    -

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_app_pb.ConnectRequest_AddrType.html b/docs/enums/v1_app_pb.ConnectRequest_AddrType.html index 29101dfb..7437d2c2 100644 --- a/docs/enums/v1_app_pb.ConnectRequest_AddrType.html +++ b/docs/enums/v1_app_pb.ConnectRequest_AddrType.html @@ -1,12 +1,12 @@ ConnectRequest_AddrType | Webmesh API

Enumeration ConnectRequest_AddrType

AddrType is the type of join addresses included in the request.

Generated

from enum v1.ConnectRequest.AddrType

-

Enumeration Members

ADDR +

Enumeration Members

ADDR MULTIADDR RENDEZVOUS

Enumeration Members

ADDR

ADDR: 0

ADDR is used to join a mesh using an IP or DNS address.

Generated

from enum value: ADDR = 0;

-

MULTIADDR

MULTIADDR: 1

MULTIADDR is used to join a mesh using a multiaddr.

+

MULTIADDR

MULTIADDR: 1

MULTIADDR is used to join a mesh using a multiaddr.

Generated

from enum value: MULTIADDR = 1;

-

RENDEZVOUS

RENDEZVOUS: 2

RENDEZVOUS is used to join a mesh using a rendezvous string.

+

RENDEZVOUS

RENDEZVOUS: 2

RENDEZVOUS is used to join a mesh using a rendezvous string.

Generated

from enum value: RENDEZVOUS = 2;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_app_pb.ConnectRequest_AuthHeader.html b/docs/enums/v1_app_pb.ConnectRequest_AuthHeader.html index 0b5f5490..60b398cd 100644 --- a/docs/enums/v1_app_pb.ConnectRequest_AuthHeader.html +++ b/docs/enums/v1_app_pb.ConnectRequest_AuthHeader.html @@ -2,7 +2,7 @@ They are used to pass authentication credentials to the daemon. Enums cannot be used as map keys, so their string values are used instead.

Generated

from enum v1.ConnectRequest.AuthHeader

-

Enumeration Members

ADDRS_ENVELOPE +

Enumeration Members

ADDRS_ENVELOPE BASIC_PASSWORD BASIC_USERNAME LDAP_PASSWORD @@ -10,12 +10,12 @@

Enumeration Members

ADDRS_ENVELOPE

ADDRS_ENVELOPE: 4

ADDRS_ENVELOPE is the header for a signed envelope containing the join addresses to use to connect to the mesh.

Generated

from enum value: ADDRS_ENVELOPE = 4;

-

BASIC_PASSWORD

BASIC_PASSWORD: 1

BASIC_PASSWORD is the password for basic authentication.

+

BASIC_PASSWORD

BASIC_PASSWORD: 1

BASIC_PASSWORD is the password for basic authentication.

Generated

from enum value: BASIC_PASSWORD = 1;

-

BASIC_USERNAME

BASIC_USERNAME: 0

BASIC_USERNAME is the username for basic authentication.

+

BASIC_USERNAME

BASIC_USERNAME: 0

BASIC_USERNAME is the username for basic authentication.

Generated

from enum value: BASIC_USERNAME = 0;

-

LDAP_PASSWORD

LDAP_PASSWORD: 3

LDAP_PASSWORD is the password for LDAP authentication.

+

LDAP_PASSWORD

LDAP_PASSWORD: 3

LDAP_PASSWORD is the password for LDAP authentication.

Generated

from enum value: LDAP_PASSWORD = 3;

-

LDAP_USERNAME

LDAP_USERNAME: 2

LDAP_USERNAME is the username for LDAP authentication.

+

LDAP_USERNAME

LDAP_USERNAME: 2

LDAP_USERNAME is the username for LDAP authentication.

Generated

from enum value: LDAP_USERNAME = 2;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_app_pb.MeshConnBootstrap_DefaultNetworkACL.html b/docs/enums/v1_app_pb.MeshConnBootstrap_DefaultNetworkACL.html index ed2ceeee..1bdb69ff 100644 --- a/docs/enums/v1_app_pb.MeshConnBootstrap_DefaultNetworkACL.html +++ b/docs/enums/v1_app_pb.MeshConnBootstrap_DefaultNetworkACL.html @@ -1,6 +1,6 @@ MeshConnBootstrap_DefaultNetworkACL | Webmesh API

Enumeration MeshConnBootstrap_DefaultNetworkACL

Generated

from enum v1.MeshConnBootstrap.DefaultNetworkACL

-

Enumeration Members

ACCEPT +

Enumeration Members

ACCEPT DROP

Enumeration Members

ACCEPT

ACCEPT: 0

Generated

from enum value: ACCEPT = 0;

-

DROP

DROP: 1

Generated

from enum value: DROP = 1;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

DROP

DROP: 1

Generated

from enum value: DROP = 1;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_app_pb.NetworkAuthMethod.html b/docs/enums/v1_app_pb.NetworkAuthMethod.html index 573740da..7b282a10 100644 --- a/docs/enums/v1_app_pb.NetworkAuthMethod.html +++ b/docs/enums/v1_app_pb.NetworkAuthMethod.html @@ -1,19 +1,19 @@ NetworkAuthMethod | Webmesh API

Enumeration NetworkAuthMethod

NetworkAuthMethod are types of RPC credentials to supply to mesh nodes.

Generated

from enum v1.NetworkAuthMethod

-

Enumeration Members

BASIC +

Enumeration Members

BASIC ID LDAP MTLS NO_AUTH

Enumeration Members

BASIC

BASIC: 1

BASIC is used to indicate that basic authentication is required.

Generated

from enum value: BASIC = 1;

-

ID

ID: 3

ID is used to indicate that an identity is required.

+

ID

ID: 3

ID is used to indicate that an identity is required.

Generated

from enum value: ID = 3;

-

LDAP

LDAP: 2

LDAP is used to indicate that LDAP authentication is required.

+

LDAP

LDAP: 2

LDAP is used to indicate that LDAP authentication is required.

Generated

from enum value: LDAP = 2;

-

MTLS

MTLS: 4

MTLS is used to indicate that mutual TLS authentication is required. +

MTLS

MTLS: 4

MTLS is used to indicate that mutual TLS authentication is required. The TLS object should be used to configure the TLS connection.

Generated

from enum value: MTLS = 4;

-

NO_AUTH

NO_AUTH: 0

NO_AUTH is used to indicate that no authentication is required.

+

NO_AUTH

NO_AUTH: 0

NO_AUTH is used to indicate that no authentication is required.

Generated

from enum value: NO_AUTH = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_app_pb.StatusResponse_ConnectionStatus.html b/docs/enums/v1_app_pb.StatusResponse_ConnectionStatus.html index dfb2439f..e4948059 100644 --- a/docs/enums/v1_app_pb.StatusResponse_ConnectionStatus.html +++ b/docs/enums/v1_app_pb.StatusResponse_ConnectionStatus.html @@ -1,11 +1,11 @@ StatusResponse_ConnectionStatus | Webmesh API

Enumeration StatusResponse_ConnectionStatus

Generated

from enum v1.StatusResponse.ConnectionStatus

-

Enumeration Members

CONNECTED +

Enumeration Members

CONNECTED CONNECTING DISCONNECTED

Enumeration Members

CONNECTED

CONNECTED: 2

CONNECTED indicates that the node is connected to a mesh.

Generated

from enum value: CONNECTED = 2;

-

CONNECTING

CONNECTING: 1

CONNECTING indicates that the node is in the process of connecting to a mesh.

+

CONNECTING

CONNECTING: 1

CONNECTING indicates that the node is in the process of connecting to a mesh.

Generated

from enum value: CONNECTING = 1;

-

DISCONNECTED

DISCONNECTED: 0

DISCONNECTED indicates that the node is not connected to a mesh.

+

DISCONNECTED

DISCONNECTED: 0

DISCONNECTED indicates that the node is not connected to a mesh.

Generated

from enum value: DISCONNECTED = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_members_pb.ConnectProtocol.html b/docs/enums/v1_members_pb.ConnectProtocol.html index e148db74..f5afa23a 100644 --- a/docs/enums/v1_members_pb.ConnectProtocol.html +++ b/docs/enums/v1_members_pb.ConnectProtocol.html @@ -1,13 +1,13 @@ ConnectProtocol | Webmesh API

Enumeration ConnectProtocol

ConnectProtocol is a type of protocol for establishing a connection into a mesh.

Generated

from enum v1.ConnectProtocol

-

Enumeration Members

CONNECT_ICE +

Enumeration Members

CONNECT_ICE CONNECT_LIBP2P CONNECT_NATIVE

Enumeration Members

CONNECT_ICE

CONNECT_ICE: 1

CONNECT_ICE indicates that the node should connect to other nodes via ICE.

Generated

from enum value: CONNECT_ICE = 1;

-

CONNECT_LIBP2P

CONNECT_LIBP2P: 2

CONNECT_LIBP2P indicates that the node should connect to other nodes via libp2p.

+

CONNECT_LIBP2P

CONNECT_LIBP2P: 2

CONNECT_LIBP2P indicates that the node should connect to other nodes via libp2p.

Generated

from enum value: CONNECT_LIBP2P = 2;

-

CONNECT_NATIVE

CONNECT_NATIVE: 0

CONNECT_NATIVE indicates that the node should connect to other nodes via the native +

CONNECT_NATIVE

CONNECT_NATIVE: 0

CONNECT_NATIVE indicates that the node should connect to other nodes via the native webmesh mechanisms.

Generated

from enum value: CONNECT_NATIVE = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_network_acls_pb.ACLAction.html b/docs/enums/v1_network_acls_pb.ACLAction.html index 0844f651..642a97da 100644 --- a/docs/enums/v1_network_acls_pb.ACLAction.html +++ b/docs/enums/v1_network_acls_pb.ACLAction.html @@ -1,12 +1,12 @@ ACLAction | Webmesh API

Enumeration ACLAction

ACLAction is the action to take when a request matches an ACL.

Generated

from enum v1.ACLAction

-

Enumeration Members

ACTION_ACCEPT +

Enumeration Members

ACTION_ACCEPT ACTION_DENY ACTION_UNKNOWN

Enumeration Members

ACTION_ACCEPT

ACTION_ACCEPT: 1

ACTION_ACCEPT allows the request to proceed.

Generated

from enum value: ACTION_ACCEPT = 1;

-

ACTION_DENY

ACTION_DENY: 2

ACTION_DENY denies the request.

+

ACTION_DENY

ACTION_DENY: 2

ACTION_DENY denies the request.

Generated

from enum value: ACTION_DENY = 2;

-

ACTION_UNKNOWN

ACTION_UNKNOWN: 0

ACTION_UNKNOWN is the default action for ACLs. It is synonymous with ACTION_DENY.

+

ACTION_UNKNOWN

ACTION_UNKNOWN: 0

ACTION_UNKNOWN is the default action for ACLs. It is synonymous with ACTION_DENY.

Generated

from enum value: ACTION_UNKNOWN = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_node_pb.ClusterStatus.html b/docs/enums/v1_node_pb.ClusterStatus.html index fed2c300..7fb67e63 100644 --- a/docs/enums/v1_node_pb.ClusterStatus.html +++ b/docs/enums/v1_node_pb.ClusterStatus.html @@ -1,18 +1,18 @@ ClusterStatus | Webmesh API

Enumeration ClusterStatus

ClusterStatus is the status of the node in the cluster.

Generated

from enum v1.ClusterStatus

-

Enumeration Members

CLUSTER_LEADER +

Enumeration Members

CLUSTER_LEADER CLUSTER_NODE CLUSTER_OBSERVER CLUSTER_STATUS_UNKNOWN CLUSTER_VOTER

Enumeration Members

CLUSTER_LEADER

CLUSTER_LEADER: 1

CLUSTER_LEADER is the status for the leader node.

Generated

from enum value: CLUSTER_LEADER = 1;

-

CLUSTER_NODE

CLUSTER_NODE: 4

CLUSTER_NODE is the status of a node that is not a part of the storage consensus.

+

CLUSTER_NODE

CLUSTER_NODE: 4

CLUSTER_NODE is the status of a node that is not a part of the storage consensus.

Generated

from enum value: CLUSTER_NODE = 4;

-

CLUSTER_OBSERVER

CLUSTER_OBSERVER: 3

CLUSTER_OBSERVER is the status for a non-voter node.

+

CLUSTER_OBSERVER

CLUSTER_OBSERVER: 3

CLUSTER_OBSERVER is the status for a non-voter node.

Generated

from enum value: CLUSTER_OBSERVER = 3;

-

CLUSTER_STATUS_UNKNOWN

CLUSTER_STATUS_UNKNOWN: 0

CLUSTER_STATUS_UNKNOWN is the default status.

+

CLUSTER_STATUS_UNKNOWN

CLUSTER_STATUS_UNKNOWN: 0

CLUSTER_STATUS_UNKNOWN is the default status.

Generated

from enum value: CLUSTER_STATUS_UNKNOWN = 0;

-

CLUSTER_VOTER

CLUSTER_VOTER: 2

CLUSTER_VOTER is the status for a voter node.

+

CLUSTER_VOTER

CLUSTER_VOTER: 2

CLUSTER_VOTER is the status for a voter node.

Generated

from enum value: CLUSTER_VOTER = 2;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_node_pb.DataChannel.html b/docs/enums/v1_node_pb.DataChannel.html index 446c5983..9a8c6ac4 100644 --- a/docs/enums/v1_node_pb.DataChannel.html +++ b/docs/enums/v1_node_pb.DataChannel.html @@ -1,14 +1,14 @@ DataChannel | Webmesh API

Enumeration DataChannel

DataChannel are the data channels used when communicating over ICE with a node.

Generated

from enum v1.DataChannel

-

Enumeration Members

CHANNELS +

Enumeration Members

CHANNELS CONNECTIONS

Enumeration Members

CHANNELS

CHANNELS: 0

CHANNELS is the data channel used for negotiating new channels. This is the first channel that is opened. The ID of the channel should be 0.

Generated

from enum value: CHANNELS = 0;

-

CONNECTIONS

CONNECTIONS: 1

CONNECTIONS is the data channel used for negotiating new connections. +

CONNECTIONS

CONNECTIONS: 1

CONNECTIONS is the data channel used for negotiating new connections. This is a channel that is opened for each incoming connection from a client. The ID should start at 0 and be incremented for each new connection.

Generated

from enum value: CONNECTIONS = 1;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_node_pb.EdgeAttribute.html b/docs/enums/v1_node_pb.EdgeAttribute.html index 7e275686..cb70e12a 100644 --- a/docs/enums/v1_node_pb.EdgeAttribute.html +++ b/docs/enums/v1_node_pb.EdgeAttribute.html @@ -1,16 +1,16 @@ EdgeAttribute | Webmesh API

Enumeration EdgeAttribute

EdgeAttribute are pre-defined edge attributes. They should be used as their string values.

Generated

from enum v1.EdgeAttribute

-

Enumeration Members

ICE +

Enumeration Members

ICE LIBP2P NATIVE UNKNOWN

Enumeration Members

ICE

ICE: 2

EDGE_ATTRIBUTE_ICE is an ICE edge attribute.

Generated

from enum value: EDGE_ATTRIBUTE_ICE = 2;

-

LIBP2P

LIBP2P: 3

EDGE_ATTRIBUTE_LIBP2P is a libp2p edge attribute.

+

LIBP2P

LIBP2P: 3

EDGE_ATTRIBUTE_LIBP2P is a libp2p edge attribute.

Generated

from enum value: EDGE_ATTRIBUTE_LIBP2P = 3;

-

NATIVE

NATIVE: 1

EDGE_ATTRIBUTE_NATIVE is a native edge attribute.

+

NATIVE

NATIVE: 1

EDGE_ATTRIBUTE_NATIVE is a native edge attribute.

Generated

from enum value: EDGE_ATTRIBUTE_NATIVE = 1;

-

UNKNOWN

UNKNOWN: 0

EDGE_ATTRIBUTE_UNKNOWN is an unknown edge attribute.

+

UNKNOWN

UNKNOWN: 0

EDGE_ATTRIBUTE_UNKNOWN is an unknown edge attribute.

Generated

from enum value: EDGE_ATTRIBUTE_UNKNOWN = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_node_pb.Feature.html b/docs/enums/v1_node_pb.Feature.html index 6150c6e2..7c979b08 100644 --- a/docs/enums/v1_node_pb.Feature.html +++ b/docs/enums/v1_node_pb.Feature.html @@ -1,6 +1,6 @@ Feature | Webmesh API

Enumeration Feature

Feature is a list of features supported by a node.

Generated

from enum v1.Feature

-

Enumeration Members

ADMIN_API +

Enumeration Members

ADMIN_API FEATURE_NONE FORWARD_MESH_DNS ICE_NEGOTIATION @@ -16,31 +16,31 @@ TURN_SERVER

Enumeration Members

ADMIN_API

ADMIN_API: 4

ADMIN_API is the feature for the admin API.

Generated

from enum value: ADMIN_API = 4;

-

FEATURE_NONE

FEATURE_NONE: 0

FEATURE_NONE is the default feature set.

+

FEATURE_NONE

FEATURE_NONE: 0

FEATURE_NONE is the default feature set.

Generated

from enum value: FEATURE_NONE = 0;

-

FORWARD_MESH_DNS

FORWARD_MESH_DNS: 10

FORWARD_MESH_DNS is the feature for forwarding mesh DNS lookups to other meshes.

+

FORWARD_MESH_DNS

FORWARD_MESH_DNS: 10

FORWARD_MESH_DNS is the feature for forwarding mesh DNS lookups to other meshes.

Generated

from enum value: FORWARD_MESH_DNS = 10;

-

ICE_NEGOTIATION

ICE_NEGOTIATION: 7

ICE_NEGOTIATION is the feature for ICE negotiation.

+

ICE_NEGOTIATION

ICE_NEGOTIATION: 7

ICE_NEGOTIATION is the feature for ICE negotiation.

Generated

from enum value: ICE_NEGOTIATION = 7;

-

LEADER_PROXY

LEADER_PROXY: 2

LEADER_PROXY is the feature for leader proxying.

+

LEADER_PROXY

LEADER_PROXY: 2

LEADER_PROXY is the feature for leader proxying.

Generated

from enum value: LEADER_PROXY = 2;

-

MEMBERSHIP

MEMBERSHIP: 5

MEMBERSHIP is the feature for membership. This is always supported on storage-providing members.

+

MEMBERSHIP

MEMBERSHIP: 5

MEMBERSHIP is the feature for membership. This is always supported on storage-providing members.

Generated

from enum value: MEMBERSHIP = 5;

-

MESH_API

MESH_API: 3

MESH_API is the feature for the mesh API. +

MESH_API

MESH_API: 3

MESH_API is the feature for the mesh API. This will be deprecated in favor of the MEMBERSHIP feature.

Generated

from enum value: MESH_API = 3;

-

MESH_DNS

MESH_DNS: 9

MESH_DNS is the feature for mesh DNS.

+

MESH_DNS

MESH_DNS: 9

MESH_DNS is the feature for mesh DNS.

Generated

from enum value: MESH_DNS = 9;

-

METRICS

METRICS: 6

METRICS is the feature for exposing metrics.

+

METRICS

METRICS: 6

METRICS is the feature for exposing metrics.

Generated

from enum value: METRICS = 6;

-

NODES

NODES: 1

NODES is the feature for nodes. This is always supported.

+

NODES

NODES: 1

NODES is the feature for nodes. This is always supported.

Generated

from enum value: NODES = 1;

-

REGISTRAR

REGISTRAR: 13

REGISTRAR is the feature for being able to register aliases to node IDs and/or public keys.

+

REGISTRAR

REGISTRAR: 13

REGISTRAR is the feature for being able to register aliases to node IDs and/or public keys.

Generated

from enum value: REGISTRAR = 13;

-

STORAGE_PROVIDER

STORAGE_PROVIDER: 12

STORAGE_PROVIDER is the feature for being able to provide distributed storage.

+

STORAGE_PROVIDER

STORAGE_PROVIDER: 12

STORAGE_PROVIDER is the feature for being able to provide distributed storage.

Generated

from enum value: STORAGE_PROVIDER = 12;

-

STORAGE_QUERIER

STORAGE_QUERIER: 11

STORAGE_QUERIER is the feature for querying, publishing, and subscribing to mesh state.

+

STORAGE_QUERIER

STORAGE_QUERIER: 11

STORAGE_QUERIER is the feature for querying, publishing, and subscribing to mesh state.

Generated

from enum value: STORAGE_QUERIER = 11;

-

TURN_SERVER

TURN_SERVER: 8

TURN_SERVER is the feature for TURN server.

+

TURN_SERVER

TURN_SERVER: 8

TURN_SERVER is the feature for TURN server.

Generated

from enum value: TURN_SERVER = 8;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_plugin_pb.Event_WatchEvent.html b/docs/enums/v1_plugin_pb.Event_WatchEvent.html index 04c7b1be..9a07260f 100644 --- a/docs/enums/v1_plugin_pb.Event_WatchEvent.html +++ b/docs/enums/v1_plugin_pb.Event_WatchEvent.html @@ -1,15 +1,15 @@ Event_WatchEvent | Webmesh API

Enumeration Event_WatchEvent

WatchEvent is the type of a watch event.

Generated

from enum v1.Event.WatchEvent

-

Enumeration Members

LEADER_CHANGE +

Enumeration Members

LEADER_CHANGE NODE_JOIN NODE_LEAVE UNKNOWN

Enumeration Members

LEADER_CHANGE

LEADER_CHANGE: 3

LEADER_CHANGE indicates that the leader of the cluster has changed.

Generated

from enum value: LEADER_CHANGE = 3;

-

NODE_JOIN

NODE_JOIN: 1

NODE_JOIN indicates that a node has joined the cluster.

+

NODE_JOIN

NODE_JOIN: 1

NODE_JOIN indicates that a node has joined the cluster.

Generated

from enum value: NODE_JOIN = 1;

-

NODE_LEAVE

NODE_LEAVE: 2

NODE_LEAVE indicates that a node has left the cluster.

+

NODE_LEAVE

NODE_LEAVE: 2

NODE_LEAVE indicates that a node has left the cluster.

Generated

from enum value: NODE_LEAVE = 2;

-

UNKNOWN

UNKNOWN: 0

UNKNOWN is the default value of WatchEvent.

+

UNKNOWN

UNKNOWN: 0

UNKNOWN is the default value of WatchEvent.

Generated

from enum value: UNKNOWN = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_plugin_pb.PluginInfo_PluginCapability.html b/docs/enums/v1_plugin_pb.PluginInfo_PluginCapability.html index e38109dd..b8348370 100644 --- a/docs/enums/v1_plugin_pb.PluginInfo_PluginCapability.html +++ b/docs/enums/v1_plugin_pb.PluginInfo_PluginCapability.html @@ -1,6 +1,6 @@ PluginInfo_PluginCapability | Webmesh API

Enumeration PluginInfo_PluginCapability

PluginCapability is the capabilities of a plugin.

Generated

from enum v1.PluginInfo.PluginCapability

-

Enumeration Members

AUTH +

Enumeration Members

AUTH IPAMV4 STORAGE_PROVIDER STORAGE_QUERIER @@ -8,14 +8,14 @@ WATCH

Enumeration Members

AUTH

AUTH: 2

AUTH indicates that the plugin is an auth plugin.

Generated

from enum value: AUTH = 2;

-

IPAMV4

IPAMV4: 4

IPAMV4 indicates that the plugin is an IPv4 IPAM plugin.

+

IPAMV4

IPAMV4: 4

IPAMV4 indicates that the plugin is an IPv4 IPAM plugin.

Generated

from enum value: IPAMV4 = 4;

-

STORAGE_PROVIDER

STORAGE_PROVIDER: 1

STORAGE_PROVIDER indicates that the plugin can provide storage and underlying consistency.

+

STORAGE_PROVIDER

STORAGE_PROVIDER: 1

STORAGE_PROVIDER indicates that the plugin can provide storage and underlying consistency.

Generated

from enum value: STORAGE_PROVIDER = 1;

-

STORAGE_QUERIER

STORAGE_QUERIER: 5

STORAGE_QUERIER indicates a plugin that wants to interact with storage.

+

STORAGE_QUERIER

STORAGE_QUERIER: 5

STORAGE_QUERIER indicates a plugin that wants to interact with storage.

Generated

from enum value: STORAGE_QUERIER = 5;

-

UNKNOWN

UNKNOWN: 0

UNKNOWN is the default value of PluginCapability.

+

UNKNOWN

UNKNOWN: 0

UNKNOWN is the default value of PluginCapability.

Generated

from enum value: UNKNOWN = 0;

-

WATCH

WATCH: 3

WATCH indicates that the plugin wants to receive watch events.

+

WATCH

WATCH: 3

WATCH indicates that the plugin wants to receive watch events.

Generated

from enum value: WATCH = 3;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_raft_pb.RaftCommandType.html b/docs/enums/v1_raft_pb.RaftCommandType.html index a65e1cc7..627a4a85 100644 --- a/docs/enums/v1_raft_pb.RaftCommandType.html +++ b/docs/enums/v1_raft_pb.RaftCommandType.html @@ -1,13 +1,13 @@ RaftCommandType | Webmesh API

Enumeration RaftCommandType

RaftCommandType is the type of command being sent to the Raft log.

Generated

from enum v1.RaftCommandType

-

Enumeration Members

DELETE +

Enumeration Members

DELETE PUT UNKNOWN

Enumeration Members

DELETE

DELETE: 2

DELETE is the command for deleting a key/value pair.

Generated

from enum value: DELETE = 2;

-

PUT

PUT: 1

PUT is the command for putting a key/value pair.

+

PUT

PUT: 1

PUT is the command for putting a key/value pair.

Generated

from enum value: PUT = 1;

-

UNKNOWN

UNKNOWN: 0

UNKNOWN is the unknown command type.

+

UNKNOWN

UNKNOWN: 0

UNKNOWN is the unknown command type.

Generated

from enum value: UNKNOWN = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_rbac_pb.RuleResource.html b/docs/enums/v1_rbac_pb.RuleResource.html index e9506412..ff811ecb 100644 --- a/docs/enums/v1_rbac_pb.RuleResource.html +++ b/docs/enums/v1_rbac_pb.RuleResource.html @@ -1,6 +1,6 @@ RuleResource | Webmesh API

Enumeration RuleResource

RuleResource is the resource type for a rule.

Generated

from enum v1.RuleResource

-

Enumeration Members

RESOURCE_ALL +

Enumeration Members

RESOURCE_ALL RESOURCE_DATA_CHANNELS RESOURCE_EDGES RESOURCE_GROUPS @@ -14,28 +14,28 @@ RESOURCE_VOTES

Enumeration Members

RESOURCE_ALL

RESOURCE_ALL: 999

RESOURCE_ALL is a wildcard resource that matches all resources.

Generated

from enum value: RESOURCE_ALL = 999;

-

RESOURCE_DATA_CHANNELS

RESOURCE_DATA_CHANNELS: 7

RESOURCE_DATA_CHANNELS is the resource for creating data channels.

+

RESOURCE_DATA_CHANNELS

RESOURCE_DATA_CHANNELS: 7

RESOURCE_DATA_CHANNELS is the resource for creating data channels.

Generated

from enum value: RESOURCE_DATA_CHANNELS = 7;

-

RESOURCE_EDGES

RESOURCE_EDGES: 8

RESOURCE_EDGES is the resource for managing edges between nodes.

+

RESOURCE_EDGES

RESOURCE_EDGES: 8

RESOURCE_EDGES is the resource for managing edges between nodes.

Generated

from enum value: RESOURCE_EDGES = 8;

-

RESOURCE_GROUPS

RESOURCE_GROUPS: 4

RESOURCE_GROUPS is the resource for managing groups.

+

RESOURCE_GROUPS

RESOURCE_GROUPS: 4

RESOURCE_GROUPS is the resource for managing groups.

Generated

from enum value: RESOURCE_GROUPS = 4;

-

RESOURCE_NETWORK_ACLS

RESOURCE_NETWORK_ACLS: 5

RESOURCE_NETWORK_ACLS is the resource for managing network ACLs.

+

RESOURCE_NETWORK_ACLS

RESOURCE_NETWORK_ACLS: 5

RESOURCE_NETWORK_ACLS is the resource for managing network ACLs.

Generated

from enum value: RESOURCE_NETWORK_ACLS = 5;

-

RESOURCE_OBSERVERS

RESOURCE_OBSERVERS: 9

RESOURCE_OBSERVERS is the resource for managing observers. The only +

RESOURCE_OBSERVERS

RESOURCE_OBSERVERS: 9

RESOURCE_OBSERVERS is the resource for managing observers. The only verb evaluated for this resource is PUT.

Generated

from enum value: RESOURCE_OBSERVERS = 9;

-

RESOURCE_PUBSUB

RESOURCE_PUBSUB: 10

RESOURCE_PUBSUB is the resource for managing pubsub topics.

+

RESOURCE_PUBSUB

RESOURCE_PUBSUB: 10

RESOURCE_PUBSUB is the resource for managing pubsub topics.

Generated

from enum value: RESOURCE_PUBSUB = 10;

-

RESOURCE_ROLES

RESOURCE_ROLES: 2

RESOURCE_ROLES is the resource for managing roles.

+

RESOURCE_ROLES

RESOURCE_ROLES: 2

RESOURCE_ROLES is the resource for managing roles.

Generated

from enum value: RESOURCE_ROLES = 2;

-

RESOURCE_ROLE_BINDINGS

RESOURCE_ROLE_BINDINGS: 3

RESOURCE_ROLE_BINDINGS is the resource for managing role bindings.

+

RESOURCE_ROLE_BINDINGS

RESOURCE_ROLE_BINDINGS: 3

RESOURCE_ROLE_BINDINGS is the resource for managing role bindings.

Generated

from enum value: RESOURCE_ROLE_BINDINGS = 3;

-

RESOURCE_ROUTES

RESOURCE_ROUTES: 6

RESOURCE_ROUTES is the resource for managing routes.

+

RESOURCE_ROUTES

RESOURCE_ROUTES: 6

RESOURCE_ROUTES is the resource for managing routes.

Generated

from enum value: RESOURCE_ROUTES = 6;

-

RESOURCE_UNKNOWN

RESOURCE_UNKNOWN: 0

RESOURCE_UNKNOWN is an unknown resource.

+

RESOURCE_UNKNOWN

RESOURCE_UNKNOWN: 0

RESOURCE_UNKNOWN is an unknown resource.

Generated

from enum value: RESOURCE_UNKNOWN = 0;

-

RESOURCE_VOTES

RESOURCE_VOTES: 1

RESOURCE_VOTES is the resource for voting in storage elections. The only +

RESOURCE_VOTES

RESOURCE_VOTES: 1

RESOURCE_VOTES is the resource for voting in storage elections. The only verb evaluated for this resource is PUT.

Generated

from enum value: RESOURCE_VOTES = 1;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_rbac_pb.RuleVerb.html b/docs/enums/v1_rbac_pb.RuleVerb.html index 918fbcd7..30c252af 100644 --- a/docs/enums/v1_rbac_pb.RuleVerb.html +++ b/docs/enums/v1_rbac_pb.RuleVerb.html @@ -1,18 +1,18 @@ RuleVerb | Webmesh API

Enumeration RuleVerb

RuleVerb is the verb type for a rule.

Generated

from enum v1.RuleVerb

-

Enumeration Members

VERB_ALL +

Enumeration Members

VERB_ALL VERB_DELETE VERB_GET VERB_PUT VERB_UNKNOWN

Enumeration Members

VERB_ALL

VERB_ALL: 999

VERB_ALL is a wildcard verb that matches all verbs.

Generated

from enum value: VERB_ALL = 999;

-

VERB_DELETE

VERB_DELETE: 3

VERB_DELETE is the verb for deleting a resource.

+

VERB_DELETE

VERB_DELETE: 3

VERB_DELETE is the verb for deleting a resource.

Generated

from enum value: VERB_DELETE = 3;

-

VERB_GET

VERB_GET: 2

VERB_GET is the verb for getting a resource.

+

VERB_GET

VERB_GET: 2

VERB_GET is the verb for getting a resource.

Generated

from enum value: VERB_GET = 2;

-

VERB_PUT

VERB_PUT: 1

VERB_PUT is the verb for creating or updating a resource.

+

VERB_PUT

VERB_PUT: 1

VERB_PUT is the verb for creating or updating a resource.

Generated

from enum value: VERB_PUT = 1;

-

VERB_UNKNOWN

VERB_UNKNOWN: 0

VERB_UNKNOWN is an unknown verb.

+

VERB_UNKNOWN

VERB_UNKNOWN: 0

VERB_UNKNOWN is an unknown verb.

Generated

from enum value: VERB_UNKNOWN = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_rbac_pb.SubjectType.html b/docs/enums/v1_rbac_pb.SubjectType.html index 0aff47d8..e8fcae94 100644 --- a/docs/enums/v1_rbac_pb.SubjectType.html +++ b/docs/enums/v1_rbac_pb.SubjectType.html @@ -1,6 +1,6 @@ SubjectType | Webmesh API

Enumeration SubjectType

SubjectType is the type of a subject.

Generated

from enum v1.SubjectType

-

Enumeration Members

SUBJECT_ALL +

Enumeration Members

SUBJECT_ALL SUBJECT_GROUP SUBJECT_NODE SUBJECT_UNKNOWN @@ -8,12 +8,12 @@

Enumeration Members

SUBJECT_ALL

SUBJECT_ALL: 999

SUBJECT_ALL is a wildcard subject type that matches all subject types. It can be used with a subject named '*' to match all subjects.

Generated

from enum value: SUBJECT_ALL = 999;

-

SUBJECT_GROUP

SUBJECT_GROUP: 3

SUBJECT_GROUP is a subject type for a group.

+

SUBJECT_GROUP

SUBJECT_GROUP: 3

SUBJECT_GROUP is a subject type for a group.

Generated

from enum value: SUBJECT_GROUP = 3;

-

SUBJECT_NODE

SUBJECT_NODE: 1

SUBJECT_NODE is a subject type for a node.

+

SUBJECT_NODE

SUBJECT_NODE: 1

SUBJECT_NODE is a subject type for a node.

Generated

from enum value: SUBJECT_NODE = 1;

-

SUBJECT_UNKNOWN

SUBJECT_UNKNOWN: 0

SUBJECT_UNKNOWN is an unknown subject type.

+

SUBJECT_UNKNOWN

SUBJECT_UNKNOWN: 0

SUBJECT_UNKNOWN is an unknown subject type.

Generated

from enum value: SUBJECT_UNKNOWN = 0;

-

SUBJECT_USER

SUBJECT_USER: 2

SUBJECT_USER is a subject type for a user.

+

SUBJECT_USER

SUBJECT_USER: 2

SUBJECT_USER is a subject type for a user.

Generated

from enum value: SUBJECT_USER = 2;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_storage_provider_pb.PrefixEvent_EventType.html b/docs/enums/v1_storage_provider_pb.PrefixEvent_EventType.html index aa7bd222..4310eea7 100644 --- a/docs/enums/v1_storage_provider_pb.PrefixEvent_EventType.html +++ b/docs/enums/v1_storage_provider_pb.PrefixEvent_EventType.html @@ -1,11 +1,11 @@ PrefixEvent_EventType | Webmesh API

Enumeration PrefixEvent_EventType

Generated

from enum v1.PrefixEvent.EventType

-

Enumeration Members

EventTypeRemoved +

Enumeration Members

EventTypeRemoved EventTypeUnknown EventTypeUpdated

Enumeration Members

EventTypeRemoved

EventTypeRemoved: 2

EventTypeRemoved is an event for when a value is removed.

Generated

from enum value: EventTypeRemoved = 2;

-

EventTypeUnknown

EventTypeUnknown: 0

EventTypeUnknown is an unknown event type.

+

EventTypeUnknown

EventTypeUnknown: 0

EventTypeUnknown is an unknown event type.

Generated

from enum value: EventTypeUnknown = 0;

-

EventTypeUpdated

EventTypeUpdated: 1

EventTypeUpdated is an event for when a value is added or updated.

+

EventTypeUpdated

EventTypeUpdated: 1

EventTypeUpdated is an event for when a value is added or updated.

Generated

from enum value: EventTypeUpdated = 1;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_storage_query_pb.QueryRequest_QueryCommand.html b/docs/enums/v1_storage_query_pb.QueryRequest_QueryCommand.html index 9e1757e5..badbcef6 100644 --- a/docs/enums/v1_storage_query_pb.QueryRequest_QueryCommand.html +++ b/docs/enums/v1_storage_query_pb.QueryRequest_QueryCommand.html @@ -1,15 +1,15 @@ QueryRequest_QueryCommand | Webmesh API

Enumeration QueryRequest_QueryCommand

QueryCommand is the type of the query.

Generated

from enum v1.QueryRequest.QueryCommand

-

Enumeration Members

DELETE +

Enumeration Members

DELETE GET LIST PUT

Enumeration Members

DELETE

DELETE: 3

DELETE is the command to delete a value.

Generated

from enum value: DELETE = 3;

-

GET

GET: 0

GET is the command to get a value.

+

GET

GET: 0

GET is the command to get a value.

Generated

from enum value: GET = 0;

-

LIST

LIST: 1

LIST is the command to list keys with an optional prefix.

+

LIST

LIST: 1

LIST is the command to list keys with an optional prefix.

Generated

from enum value: LIST = 1;

-

PUT

PUT: 2

PUT is the command to put a value.

+

PUT

PUT: 2

PUT is the command to put a value.

Generated

from enum value: PUT = 2;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/v1_storage_query_pb.QueryRequest_QueryType.html b/docs/enums/v1_storage_query_pb.QueryRequest_QueryType.html index 662fcfac..d8050b5d 100644 --- a/docs/enums/v1_storage_query_pb.QueryRequest_QueryType.html +++ b/docs/enums/v1_storage_query_pb.QueryRequest_QueryType.html @@ -1,6 +1,6 @@ QueryRequest_QueryType | Webmesh API

Enumeration QueryRequest_QueryType

QueryType is the type of object being queried.

Generated

from enum v1.QueryRequest.QueryType

-

Enumeration Members

ACLS +

Enumeration Members

ACLS EDGES GROUPS KEYS @@ -13,25 +13,25 @@ VALUE

Enumeration Members

ACLS

ACLS: 5

ACLS is the type for querying ACLs.

Generated

from enum value: ACLS = 5;

-

EDGES

EDGES: 3

EDGES is the type for querying edges.

+

EDGES

EDGES: 3

EDGES is the type for querying edges.

Generated

from enum value: EDGES = 3;

-

GROUPS

GROUPS: 8

GROUPS is the type for querying groups.

+

GROUPS

GROUPS: 8

GROUPS is the type for querying groups.

Generated

from enum value: GROUPS = 8;

-

KEYS

KEYS: 1

KEYS is the type for querying keys.

+

KEYS

KEYS: 1

KEYS is the type for querying keys.

Generated

from enum value: KEYS = 1;

-

NETWORK_STATE

NETWORK_STATE: 9

NETWORK_STATE is the type for querying network configuration.

+

NETWORK_STATE

NETWORK_STATE: 9

NETWORK_STATE is the type for querying network configuration.

Generated

from enum value: NETWORK_STATE = 9;

-

PEERS

PEERS: 2

PEERS is the type for querying peers.

+

PEERS

PEERS: 2

PEERS is the type for querying peers.

Generated

from enum value: PEERS = 2;

-

RBAC_STATE

RBAC_STATE: 10

RBAC_STATE is the type for querying RBAC configuration. +

RBAC_STATE

RBAC_STATE: 10

RBAC_STATE is the type for querying RBAC configuration. This will return a single item of true or false.

Generated

from enum value: RBAC_STATE = 10;

-

ROLEBINDINGS

ROLEBINDINGS: 7

ROLEBINDINGS is the type for querying role bindings.

+

ROLEBINDINGS

ROLEBINDINGS: 7

ROLEBINDINGS is the type for querying role bindings.

Generated

from enum value: ROLEBINDINGS = 7;

-

ROLES

ROLES: 6

ROLES is the type for querying roles.

+

ROLES

ROLES: 6

ROLES is the type for querying roles.

Generated

from enum value: ROLES = 6;

-

ROUTES

ROUTES: 4

ROUTES is the type for querying routes.

+

ROUTES

ROUTES: 4

ROUTES is the type for querying routes.

Generated

from enum value: ROUTES = 4;

-

VALUE

VALUE: 0

VALUE represents a raw value query at a supplied key.

+

VALUE

VALUE: 0

VALUE represents a raw value query at a supplied key.

Generated

from enum value: VALUE = 0;

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/utils_rpcdb.html b/docs/modules/utils_rpcdb.html index 8605449d..d948dcdc 100644 --- a/docs/modules/utils_rpcdb.html +++ b/docs/modules/utils_rpcdb.html @@ -1,4 +1,4 @@ -utils/rpcdb | Webmesh API

Module utils/rpcdb

Index

Classes

Groups +utils/rpcdb | Webmesh API

Module utils/rpcdb

Index

Classes

Groups MeshEdges MeshNodes NetworkACLs diff --git a/docs/modules/v1_admin_connect.html b/docs/modules/v1_admin_connect.html index c59e7627..584e78bd 100644 --- a/docs/modules/v1_admin_connect.html +++ b/docs/modules/v1_admin_connect.html @@ -1,2 +1,2 @@ -v1/admin_connect | Webmesh API

Module v1/admin_connect

Index

Variables

Admin +v1/admin_connect | Webmesh API

Module v1/admin_connect

Index

Variables

Admin

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_app_connect.html b/docs/modules/v1_app_connect.html index bc6fa48e..3be01410 100644 --- a/docs/modules/v1_app_connect.html +++ b/docs/modules/v1_app_connect.html @@ -1,2 +1,2 @@ -v1/app_connect | Webmesh API

Module v1/app_connect

Index

Variables

AppDaemon +v1/app_connect | Webmesh API

Module v1/app_connect

Index

Variables

AppDaemon

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_app_pb.html b/docs/modules/v1_app_pb.html index 7fbb1881..cb51d162 100644 --- a/docs/modules/v1_app_pb.html +++ b/docs/modules/v1_app_pb.html @@ -1,4 +1,4 @@ -v1/app_pb | Webmesh API

Module v1/app_pb

Index

Enumerations

ConnectRequest_AddrType +v1/app_pb | Webmesh API

Module v1/app_pb

Index

Enumerations

ConnectRequest_AddrType ConnectRequest_AuthHeader MeshConnBootstrap_DefaultNetworkACL NetworkAuthMethod diff --git a/docs/modules/v1_members_connect.html b/docs/modules/v1_members_connect.html index 3880597c..4cbb5eb4 100644 --- a/docs/modules/v1_members_connect.html +++ b/docs/modules/v1_members_connect.html @@ -1,2 +1,2 @@ -v1/members_connect | Webmesh API

Module v1/members_connect

Index

Variables

Membership +v1/members_connect | Webmesh API

Module v1/members_connect

Index

Variables

Membership

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_members_pb.html b/docs/modules/v1_members_pb.html index cc3754c8..86f47c74 100644 --- a/docs/modules/v1_members_pb.html +++ b/docs/modules/v1_members_pb.html @@ -1,4 +1,4 @@ -v1/members_pb | Webmesh API

Module v1/members_pb

Index

Enumerations

ConnectProtocol +v1/members_pb | Webmesh API

Module v1/members_pb

Index

Enumerations

ConnectProtocol

Classes

JoinRequest JoinResponse LeaveRequest diff --git a/docs/modules/v1_mesh_connect.html b/docs/modules/v1_mesh_connect.html index bfbb37e7..d68b1205 100644 --- a/docs/modules/v1_mesh_connect.html +++ b/docs/modules/v1_mesh_connect.html @@ -1,2 +1,2 @@ -v1/mesh_connect | Webmesh API

Module v1/mesh_connect

Index

Variables

Mesh +v1/mesh_connect | Webmesh API

Module v1/mesh_connect

Index

Variables

Mesh

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_mesh_pb.html b/docs/modules/v1_mesh_pb.html index 7d8994a3..3f5e384e 100644 --- a/docs/modules/v1_mesh_pb.html +++ b/docs/modules/v1_mesh_pb.html @@ -1,4 +1,4 @@ -v1/mesh_pb | Webmesh API

Module v1/mesh_pb

Index

Classes

GetNodeRequest +v1/mesh_pb | Webmesh API

Module v1/mesh_pb

Index

Classes

GetNodeRequest MeshEdge MeshEdges MeshGraph diff --git a/docs/modules/v1_network_acls_pb.html b/docs/modules/v1_network_acls_pb.html index a2cc8bb6..a4b510da 100644 --- a/docs/modules/v1_network_acls_pb.html +++ b/docs/modules/v1_network_acls_pb.html @@ -1,4 +1,4 @@ -v1/network_acls_pb | Webmesh API

Module v1/network_acls_pb

Index

Enumerations

ACLAction +v1/network_acls_pb | Webmesh API

Module v1/network_acls_pb

Index

Enumerations

ACLAction

Classes

NetworkACL NetworkACLs NetworkAction diff --git a/docs/modules/v1_node_connect.html b/docs/modules/v1_node_connect.html index 4d7f4887..d99f19ff 100644 --- a/docs/modules/v1_node_connect.html +++ b/docs/modules/v1_node_connect.html @@ -1,2 +1,2 @@ -v1/node_connect | Webmesh API

Module v1/node_connect

Index

Variables

Node +v1/node_connect | Webmesh API

Module v1/node_connect

Index

Variables

Node

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_node_pb.html b/docs/modules/v1_node_pb.html index 33ca6dd1..35515156 100644 --- a/docs/modules/v1_node_pb.html +++ b/docs/modules/v1_node_pb.html @@ -1,4 +1,4 @@ -v1/node_pb | Webmesh API

Module v1/node_pb

Index

Enumerations

ClusterStatus +v1/node_pb | Webmesh API

Module v1/node_pb

Index

Enumerations

ClusterStatus DataChannel EdgeAttribute Feature diff --git a/docs/modules/v1_plugin_connect.html b/docs/modules/v1_plugin_connect.html index 1b252530..2bcaa33f 100644 --- a/docs/modules/v1_plugin_connect.html +++ b/docs/modules/v1_plugin_connect.html @@ -1,4 +1,4 @@ -v1/plugin_connect | Webmesh API

Module v1/plugin_connect

Index

Variables

AuthPlugin +v1/plugin_connect | Webmesh API

Module v1/plugin_connect

Index

Variables

AuthPlugin IPAMPlugin Plugin StorageQuerierPlugin diff --git a/docs/modules/v1_plugin_pb.html b/docs/modules/v1_plugin_pb.html index 954620c8..88a9c601 100644 --- a/docs/modules/v1_plugin_pb.html +++ b/docs/modules/v1_plugin_pb.html @@ -1,4 +1,4 @@ -v1/plugin_pb | Webmesh API

Module v1/plugin_pb

Index

Enumerations

Event_WatchEvent +v1/plugin_pb | Webmesh API

Module v1/plugin_pb

Index

Enumerations

Event_WatchEvent PluginInfo_PluginCapability

Classes

AllocateIPRequest AllocatedIP diff --git a/docs/modules/v1_raft_pb.html b/docs/modules/v1_raft_pb.html index 5ec266ab..6fe26815 100644 --- a/docs/modules/v1_raft_pb.html +++ b/docs/modules/v1_raft_pb.html @@ -1,4 +1,4 @@ -v1/raft_pb | Webmesh API

Module v1/raft_pb

Index

Enumerations

RaftCommandType +v1/raft_pb | Webmesh API

Module v1/raft_pb

Index

Enumerations

RaftCommandType

Classes

RaftApplyResponse RaftDataItem RaftLogEntry diff --git a/docs/modules/v1_rbac_pb.html b/docs/modules/v1_rbac_pb.html index 91aa67fe..e967700b 100644 --- a/docs/modules/v1_rbac_pb.html +++ b/docs/modules/v1_rbac_pb.html @@ -1,4 +1,4 @@ -v1/rbac_pb | Webmesh API

Module v1/rbac_pb

Index

Enumerations

RuleResource +v1/rbac_pb | Webmesh API

Module v1/rbac_pb

Index

Enumerations

RuleResource RuleVerb SubjectType

Classes

Group diff --git a/docs/modules/v1_registrar_connect.html b/docs/modules/v1_registrar_connect.html index a5d0f15b..a4f2d5ad 100644 --- a/docs/modules/v1_registrar_connect.html +++ b/docs/modules/v1_registrar_connect.html @@ -1,2 +1,2 @@ -v1/registrar_connect | Webmesh API

Module v1/registrar_connect

Index

Variables

Registrar +v1/registrar_connect | Webmesh API

Module v1/registrar_connect

Index

Variables

Registrar

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_registrar_pb.html b/docs/modules/v1_registrar_pb.html index 8ebd84e3..b1a09e5f 100644 --- a/docs/modules/v1_registrar_pb.html +++ b/docs/modules/v1_registrar_pb.html @@ -1,4 +1,4 @@ -v1/registrar_pb | Webmesh API

Module v1/registrar_pb

Index

Classes

LookupRequest +v1/registrar_pb | Webmesh API

Module v1/registrar_pb

Index

Classes

LookupRequest LookupResponse RegisterRequest RegisterResponse diff --git a/docs/modules/v1_storage_provider_connect.html b/docs/modules/v1_storage_provider_connect.html index 5f9c10ab..de31b1d5 100644 --- a/docs/modules/v1_storage_provider_connect.html +++ b/docs/modules/v1_storage_provider_connect.html @@ -1,2 +1,2 @@ -v1/storage_provider_connect | Webmesh API

Module v1/storage_provider_connect

Index

Variables

StorageProviderPlugin +v1/storage_provider_connect | Webmesh API

Module v1/storage_provider_connect

Index

Variables

StorageProviderPlugin

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_storage_provider_pb.html b/docs/modules/v1_storage_provider_pb.html index 1621e672..33782a81 100644 --- a/docs/modules/v1_storage_provider_pb.html +++ b/docs/modules/v1_storage_provider_pb.html @@ -1,4 +1,4 @@ -v1/storage_provider_pb | Webmesh API

Module v1/storage_provider_pb

Index

Enumerations

PrefixEvent_EventType +v1/storage_provider_pb | Webmesh API

Module v1/storage_provider_pb

Index

Enumerations

PrefixEvent_EventType

Classes

AddObserverResponse AddVoterResponse BootstrapRequest diff --git a/docs/modules/v1_storage_query_connect.html b/docs/modules/v1_storage_query_connect.html index 8d1c4ec4..d69f0091 100644 --- a/docs/modules/v1_storage_query_connect.html +++ b/docs/modules/v1_storage_query_connect.html @@ -1,2 +1,2 @@ -v1/storage_query_connect | Webmesh API

Module v1/storage_query_connect

Index

Variables

StorageQueryService +v1/storage_query_connect | Webmesh API

Module v1/storage_query_connect

Index

Variables

StorageQueryService

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_storage_query_pb.html b/docs/modules/v1_storage_query_pb.html index ec388ff2..1c1339e2 100644 --- a/docs/modules/v1_storage_query_pb.html +++ b/docs/modules/v1_storage_query_pb.html @@ -1,4 +1,4 @@ -v1/storage_query_pb | Webmesh API

Module v1/storage_query_pb

Index

Enumerations

QueryRequest_QueryCommand +v1/storage_query_pb | Webmesh API

Module v1/storage_query_pb

Index

Enumerations

QueryRequest_QueryCommand QueryRequest_QueryType

Classes

NetworkState PublishRequest diff --git a/docs/modules/v1_webrtc_connect.html b/docs/modules/v1_webrtc_connect.html index 760bd6b9..177b012d 100644 --- a/docs/modules/v1_webrtc_connect.html +++ b/docs/modules/v1_webrtc_connect.html @@ -1,2 +1,2 @@ -v1/webrtc_connect | Webmesh API

Module v1/webrtc_connect

Index

Variables

WebRTC +v1/webrtc_connect | Webmesh API

Module v1/webrtc_connect

Index

Variables

WebRTC

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/v1_webrtc_pb.html b/docs/modules/v1_webrtc_pb.html index e6e2704f..0900f519 100644 --- a/docs/modules/v1_webrtc_pb.html +++ b/docs/modules/v1_webrtc_pb.html @@ -1,3 +1,3 @@ -v1/webrtc_pb | Webmesh API

Module v1/webrtc_pb

Index

Classes

DataChannelOffer +v1/webrtc_pb | Webmesh API

Module v1/webrtc_pb

Index

Classes

DataChannelOffer StartDataChannelRequest

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/v1_admin_connect.Admin.html b/docs/variables/v1_admin_connect.Admin.html index 31583424..e5be6334 100644 --- a/docs/variables/v1_admin_connect.Admin.html +++ b/docs/variables/v1_admin_connect.Admin.html @@ -49,4 +49,4 @@
  • Readonly I: typeof RoleBinding
  • Readonly O: typeof Empty
  • Readonly kind: MethodKind.Unary
  • Readonly name: "PutRoleBinding"
  • Readonly putRoute: {
        I: typeof Route;
        O: typeof Empty;
        kind: MethodKind.Unary;
        name: "PutRoute";
    }

    PutRoute creates or updates a route.

    Generated

    from rpc v1.Admin.PutRoute

    • Readonly I: typeof Route
    • Readonly O: typeof Empty
    • Readonly kind: MethodKind.Unary
    • Readonly name: "PutRoute"
  • Readonly typeName: "v1.Admin"

    • Generated

    from service v1.Admin

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_app_connect.AppDaemon.html b/docs/variables/v1_app_connect.AppDaemon.html index 9484bfcb..bcd8c880 100644 --- a/docs/variables/v1_app_connect.AppDaemon.html +++ b/docs/variables/v1_app_connect.AppDaemon.html @@ -12,4 +12,4 @@
  • Readonly status: {
        I: typeof StatusRequest;
        O: typeof StatusResponse;
        kind: MethodKind.Unary;
        name: "Status";
    }

    Status is used to retrieve the status of a mesh connection.

    Generated

    from rpc v1.AppDaemon.Status

  • Readonly typeName: "v1.AppDaemon"

    • Generated

    from service v1.AppDaemon

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_members_connect.Membership.html b/docs/variables/v1_members_connect.Membership.html index 7c4c1bcd..0f2f85d9 100644 --- a/docs/variables/v1_members_connect.Membership.html +++ b/docs/variables/v1_members_connect.Membership.html @@ -21,4 +21,4 @@ with the same ID, but redefined to avoid confusion and to allow for expansion.

    Generated

    from rpc v1.Membership.Update

  • Readonly typeName: "v1.Membership"

    • Generated

    from service v1.Membership

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_mesh_connect.Mesh.html b/docs/variables/v1_mesh_connect.Mesh.html index 067d9df7..1c26daf6 100644 --- a/docs/variables/v1_mesh_connect.Mesh.html +++ b/docs/variables/v1_mesh_connect.Mesh.html @@ -8,4 +8,4 @@
    • Readonly I: typeof GetNodeRequest
    • Readonly O: typeof MeshNode
    • Readonly kind: MethodKind.Unary
    • Readonly name: "GetNode"
  • Readonly listNodes: {
        I: typeof Empty;
        O: typeof NodeList;
        kind: MethodKind.Unary;
        name: "ListNodes";
    }

    ListNodes lists all nodes.

    Generated

    from rpc v1.Mesh.ListNodes

    • Readonly I: typeof Empty
    • Readonly O: typeof NodeList
    • Readonly kind: MethodKind.Unary
    • Readonly name: "ListNodes"
  • Readonly typeName: "v1.Mesh"

    • Generated

    from service v1.Mesh

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_node_connect.Node.html b/docs/variables/v1_node_connect.Node.html index c1a7b54f..9a12b559 100644 --- a/docs/variables/v1_node_connect.Node.html +++ b/docs/variables/v1_node_connect.Node.html @@ -16,4 +16,4 @@ candidates.

    Generated

    from rpc v1.Node.ReceiveSignalChannel

    • Readonly I: typeof WebRTCSignal
    • Readonly O: typeof WebRTCSignal
    • Readonly kind: MethodKind.BiDiStreaming
    • Readonly name: "ReceiveSignalChannel"
  • Readonly typeName: "v1.Node"

    • Generated

    from service v1.Node

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_plugin_connect.AuthPlugin.html b/docs/variables/v1_plugin_connect.AuthPlugin.html index 356ce280..d6b5f1aa 100644 --- a/docs/variables/v1_plugin_connect.AuthPlugin.html +++ b/docs/variables/v1_plugin_connect.AuthPlugin.html @@ -2,4 +2,4 @@

    Type declaration

    • Readonly methods: {
          authenticate: {
              I: typeof AuthenticationRequest;
              O: typeof AuthenticationResponse;
              kind: MethodKind.Unary;
              name: "Authenticate";
          };
      }
    • Readonly typeName: "v1.AuthPlugin"

    Generated

    from service v1.AuthPlugin

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_plugin_connect.IPAMPlugin.html b/docs/variables/v1_plugin_connect.IPAMPlugin.html index 13b832e3..5f95a93b 100644 --- a/docs/variables/v1_plugin_connect.IPAMPlugin.html +++ b/docs/variables/v1_plugin_connect.IPAMPlugin.html @@ -4,4 +4,4 @@
  • Readonly release: {
        I: typeof ReleaseIPRequest;
        O: typeof Empty;
        kind: MethodKind.Unary;
        name: "Release";
    }

    Release releases an IP for a node.

    Generated

    from rpc v1.IPAMPlugin.Release

    • Readonly I: typeof ReleaseIPRequest
    • Readonly O: typeof Empty
    • Readonly kind: MethodKind.Unary
    • Readonly name: "Release"
  • Readonly typeName: "v1.IPAMPlugin"

    • Generated

    from service v1.IPAMPlugin

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_plugin_connect.Plugin.html b/docs/variables/v1_plugin_connect.Plugin.html index 6311ce36..36b228a5 100644 --- a/docs/variables/v1_plugin_connect.Plugin.html +++ b/docs/variables/v1_plugin_connect.Plugin.html @@ -7,4 +7,4 @@
    • Readonly I: typeof PluginConfiguration
    • Readonly O: typeof Empty
    • Readonly kind: MethodKind.Unary
    • Readonly name: "Configure"
  • Readonly getInfo: {
        I: typeof Empty;
        O: typeof PluginInfo;
        kind: MethodKind.Unary;
        name: "GetInfo";
    }

    GetInfo returns the information for the plugin.

    Generated

    from rpc v1.Plugin.GetInfo

    • Readonly I: typeof Empty
    • Readonly O: typeof PluginInfo
    • Readonly kind: MethodKind.Unary
    • Readonly name: "GetInfo"
  • Readonly typeName: "v1.Plugin"

    • Generated

    from service v1.Plugin

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_plugin_connect.StorageQuerierPlugin.html b/docs/variables/v1_plugin_connect.StorageQuerierPlugin.html index a8eed746..5683e2d8 100644 --- a/docs/variables/v1_plugin_connect.StorageQuerierPlugin.html +++ b/docs/variables/v1_plugin_connect.StorageQuerierPlugin.html @@ -6,4 +6,4 @@ received.

    Generated

    from rpc v1.StorageQuerierPlugin.InjectQuerier

    • Readonly I: typeof QueryResponse
    • Readonly O: typeof QueryRequest
    • Readonly kind: MethodKind.BiDiStreaming
    • Readonly name: "InjectQuerier"
  • Readonly typeName: "v1.StorageQuerierPlugin"

    • Generated

    from service v1.StorageQuerierPlugin

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_plugin_connect.WatchPlugin.html b/docs/variables/v1_plugin_connect.WatchPlugin.html index 4e55fa1c..b7b95e88 100644 --- a/docs/variables/v1_plugin_connect.WatchPlugin.html +++ b/docs/variables/v1_plugin_connect.WatchPlugin.html @@ -2,4 +2,4 @@

    Type declaration

    • Readonly methods: {
          emit: {
              I: typeof Event;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Emit";
          };
      }
      • Readonly emit: {
            I: typeof Event;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Emit";
        }

        Emit handles a watch event.

        Generated

        from rpc v1.WatchPlugin.Emit

        • Readonly I: typeof Event
        • Readonly O: typeof Empty
        • Readonly kind: MethodKind.Unary
        • Readonly name: "Emit"
    • Readonly typeName: "v1.WatchPlugin"

    Generated

    from service v1.WatchPlugin

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_registrar_connect.Registrar.html b/docs/variables/v1_registrar_connect.Registrar.html index cfbbf924..2c24b077 100644 --- a/docs/variables/v1_registrar_connect.Registrar.html +++ b/docs/variables/v1_registrar_connect.Registrar.html @@ -12,4 +12,4 @@ public key with a different alias.

    Generated

    from rpc v1.Registrar.Register

  • Readonly typeName: "v1.Registrar"

    • Generated

    from service v1.Registrar

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_storage_provider_connect.StorageProviderPlugin.html b/docs/variables/v1_storage_provider_connect.StorageProviderPlugin.html index fae3db42..3aa25136 100644 --- a/docs/variables/v1_storage_provider_connect.StorageProviderPlugin.html +++ b/docs/variables/v1_storage_provider_connect.StorageProviderPlugin.html @@ -48,4 +48,4 @@
  • Readonly subscribePrefix: {
        I: typeof SubscribePrefixRequest;
        O: typeof PrefixEvent;
        kind: MethodKind.ServerStreaming;
        name: "SubscribePrefix";
    }

    SubscribePrefix subscribes to events for a prefix.

    Generated

    from rpc v1.StorageProviderPlugin.SubscribePrefix

  • Readonly typeName: "v1.StorageProviderPlugin"

    • Generated

    from service v1.StorageProviderPlugin

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_storage_query_connect.StorageQueryService.html b/docs/variables/v1_storage_query_connect.StorageQueryService.html index 1daaa503..f22d6663 100644 --- a/docs/variables/v1_storage_query_connect.StorageQueryService.html +++ b/docs/variables/v1_storage_query_connect.StorageQueryService.html @@ -9,4 +9,4 @@ only available on nodes that are able to provide storage.

    Generated

    from rpc v1.StorageQueryService.Subscribe

  • Readonly typeName: "v1.StorageQueryService"

    • Generated

    from service v1.StorageQueryService

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/v1_webrtc_connect.WebRTC.html b/docs/variables/v1_webrtc_connect.WebRTC.html index ec369ce1..76f9e95c 100644 --- a/docs/variables/v1_webrtc_connect.WebRTC.html +++ b/docs/variables/v1_webrtc_connect.WebRTC.html @@ -15,4 +15,4 @@ are proxied to the remote node.

    Generated

    from rpc v1.WebRTC.StartSignalChannel

    • Readonly I: typeof WebRTCSignal
    • Readonly O: typeof WebRTCSignal
    • Readonly kind: MethodKind.BiDiStreaming
    • Readonly name: "StartSignalChannel"
  • Readonly typeName: "v1.WebRTC"

    • Generated

    from service v1.WebRTC

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/ts/utils/rpcdb.ts b/ts/utils/rpcdb.ts index e365cc7c..c6f8bf23 100644 --- a/ts/utils/rpcdb.ts +++ b/ts/utils/rpcdb.ts @@ -43,7 +43,7 @@ export class MeshNodes { /** * Returns the MeshNode with the given ID. * - * @param id - The ID of the node.. + * @param id - The ID of the node. * @returns The MeshNode with the given ID. */ get(id: string): Promise { @@ -74,7 +74,7 @@ export class MeshNodes { /** * Returns the MeshNode with the given pubkey. * - * @param pubkey - The base64 encoded public key of the node.. + * @param pubkey - The base64 encoded public key of the node. * @returns The MeshNode with the given pubkey. */ getByPubkey(pubkey: string): Promise { @@ -105,7 +105,7 @@ export class MeshNodes { /** * Deletes the MeshNode with the given ID. * - * @param id - The ID of the node.. + * @param id - The ID of the node. */ delete(id: string): Promise { return new Promise((resolve, reject) => { @@ -196,8 +196,8 @@ export class MeshEdges { /** * Returns the MeshEdge with the given Sourceid and Targetid. * - * @param sourceid - The ID of the source node.. - * @param targetid - The ID of the target node.. + * @param sourceid - The ID of the source node. + * @param targetid - The ID of the target node. * @returns The MeshEdge with the given Targetid and Sourceid. */ get(sourceid: string, targetid: string): Promise { @@ -228,8 +228,8 @@ export class MeshEdges { /** * Deletes the MeshEdge with the given Sourceid and Targetid. * - * @param sourceid - The ID of the source node.. - * @param targetid - The ID of the target node.. + * @param sourceid - The ID of the source node. + * @param targetid - The ID of the target node. */ delete(sourceid: string, targetid: string): Promise { return new Promise((resolve, reject) => { @@ -320,7 +320,7 @@ export class Roles { /** * Returns the Role with the given ID. * - * @param id - The name of the role.. + * @param id - The name of the role. * @returns The Role with the given ID. */ get(id: string): Promise { @@ -351,7 +351,7 @@ export class Roles { /** * Deletes the Role with the given ID. * - * @param id - The name of the role.. + * @param id - The name of the role. */ delete(id: string): Promise { return new Promise((resolve, reject) => { @@ -442,7 +442,7 @@ export class RoleBindings { /** * Returns the RoleBinding with the given ID. * - * @param id - The name of the rolebinding.. + * @param id - The name of the rolebinding. * @returns The RoleBinding with the given ID. */ get(id: string): Promise { @@ -473,7 +473,7 @@ export class RoleBindings { /** * Deletes the RoleBinding with the given ID. * - * @param id - The name of the rolebinding.. + * @param id - The name of the rolebinding. */ delete(id: string): Promise { return new Promise((resolve, reject) => { @@ -564,7 +564,7 @@ export class Groups { /** * Returns the Group with the given ID. * - * @param id - The name of the group.. + * @param id - The name of the group. * @returns The Group with the given ID. */ get(id: string): Promise { @@ -595,7 +595,7 @@ export class Groups { /** * Deletes the Group with the given ID. * - * @param id - The name of the group.. + * @param id - The name of the group. */ delete(id: string): Promise { return new Promise((resolve, reject) => { @@ -686,7 +686,7 @@ export class NetworkACLs { /** * Returns the NetworkACL with the given ID. * - * @param id - The name of the network ACL.. + * @param id - The name of the network ACL. * @returns The NetworkACL with the given ID. */ get(id: string): Promise { @@ -717,7 +717,7 @@ export class NetworkACLs { /** * Deletes the NetworkACL with the given ID. * - * @param id - The name of the network ACL.. + * @param id - The name of the network ACL. */ delete(id: string): Promise { return new Promise((resolve, reject) => { @@ -808,7 +808,7 @@ export class Routes { /** * Returns the Route with the given ID. * - * @param id - The name of the route.. + * @param id - The name of the route. * @returns The Route with the given ID. */ get(id: string): Promise { @@ -839,7 +839,7 @@ export class Routes { /** * Deletes the Route with the given ID. * - * @param id - The name of the route.. + * @param id - The name of the route. */ delete(id: string): Promise { return new Promise((resolve, reject) => { @@ -890,7 +890,7 @@ export class Routes { /** * Returns the Routes with the given cidr. * - * @param cidr - The CIDR of the route. + * @param cidr - The CIDR of the route * @returns Any Routes found with the given cidr. */ listByCidr(cidr: string): Promise { @@ -921,7 +921,7 @@ export class Routes { /** * Returns the Routes with the given nodeid. * - * @param nodeid - The ID of the node. + * @param nodeid - The ID of the node * @returns Any Routes found with the given nodeid. */ listByNodeID(nodeid: string): Promise {