@ngrok/ngrok-api 0.10.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +55 -29
- package/docs/classes/services.APIKeys.html +6 -6
- package/docs/classes/services.AbuseReports.html +3 -3
- package/docs/classes/services.AgentIngresses.html +6 -6
- package/docs/classes/services.ApplicationSessions.html +4 -4
- package/docs/classes/services.ApplicationUsers.html +4 -4
- package/docs/classes/services.BotUsers.html +352 -0
- package/docs/classes/services.CertificateAuthorities.html +6 -6
- package/docs/classes/services.Credentials.html +6 -6
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRoutePolicyModule.html +270 -0
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +270 -0
- package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +6 -6
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +6 -6
- package/docs/classes/services.EdgesTLS.html +6 -6
- package/docs/classes/services.Endpoints.html +3 -3
- package/docs/classes/services.EventDestinations.html +6 -6
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +6 -6
- package/docs/classes/services.FailoverBackends.html +6 -6
- package/docs/classes/services.HTTPResponseBackends.html +6 -6
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.IPPolicies.html +6 -6
- package/docs/classes/services.IPPolicyRules.html +6 -6
- package/docs/classes/services.IPRestrictions.html +6 -6
- package/docs/classes/services.ReservedAddrs.html +6 -6
- package/docs/classes/services.ReservedDomains.html +8 -8
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
- package/docs/classes/services.SSHCredentials.html +6 -6
- package/docs/classes/services.SSHHostCertificates.html +6 -6
- package/docs/classes/services.SSHUserCertificates.html +6 -6
- package/docs/classes/services.StaticBackends.html +360 -0
- package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
- package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +270 -0
- package/docs/classes/services.TLSCertificates.html +6 -6
- package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.TLSEdgePolicyModule.html +270 -0
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +270 -0
- package/docs/classes/services.TunnelGroupBackends.html +6 -6
- package/docs/classes/services.TunnelSessions.html +6 -6
- package/docs/classes/services.Tunnels.html +3 -3
- package/docs/classes/services.WeightedBackends.html +6 -6
- package/docs/interfaces/client.NgrokConfig.html +3 -3
- package/docs/interfaces/datatypes.APIKey.html +7 -7
- package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +7 -7
- package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +10 -10
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
- package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
- package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
- package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
- package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUser.html +243 -0
- package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
- package/docs/interfaces/datatypes.BotUserList.html +205 -0
- package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
- package/docs/interfaces/datatypes.BrowserSession.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +8 -8
- package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgePolicyReplace.html +176 -0
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRoutePolicyReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +176 -0
- package/docs/interfaces/datatypes.Endpoint.html +13 -13
- package/docs/interfaces/datatypes.EndpointAction.html +186 -0
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointRule.html +205 -0
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +186 -0
- package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +190 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +7 -7
- package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +18 -4
- package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +262 -0
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +52 -19
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +49 -16
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +50 -17
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +8 -8
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +4 -4
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +14 -14
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +7 -7
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +8 -8
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.StaticBackend.html +281 -0
- package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
- package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
- package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdge.html +27 -8
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +24 -5
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -6
- package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +29 -10
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +26 -7
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
- package/docs/interfaces/datatypes.Tunnel.html +11 -11
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +60 -0
- package/docs/modules/services.html +24 -0
- package/lib/client.d.ts +8 -1
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +4 -1
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +147 -4
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +90 -0
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +545 -226
- package/lib/services.js.map +1 -1
- package/package.json +2 -1
- package/src/client.ts +13 -2
- package/src/datatypes.ts +162 -4
- package/src/services.ts +458 -122
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>TCPEdgePolicyModule | @ngrok/ngrok-api</title>
|
|
7
|
+
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<div class="tsd-page-toolbar">
|
|
15
|
+
<div class="container">
|
|
16
|
+
<div class="table-wrap">
|
|
17
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
+
<div class="field">
|
|
19
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
+
<input id="tsd-search-field" type="text" />
|
|
21
|
+
</div>
|
|
22
|
+
<ul class="results">
|
|
23
|
+
<li class="state loading">Preparing search index...</li>
|
|
24
|
+
<li class="state failure">The search index is not available</li>
|
|
25
|
+
</ul>
|
|
26
|
+
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="table-cell" id="tsd-widgets">
|
|
29
|
+
<div id="tsd-filter">
|
|
30
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
+
<div class="tsd-filter-group">
|
|
32
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
+
<span class="tsd-select-label">All</span>
|
|
34
|
+
<ul class="tsd-select-list">
|
|
35
|
+
<li data-value="public">Public</li>
|
|
36
|
+
<li data-value="protected">Public/Protected</li>
|
|
37
|
+
<li data-value="private" class="selected">All</li>
|
|
38
|
+
</ul>
|
|
39
|
+
</div>
|
|
40
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-page-title">
|
|
52
|
+
<div class="container">
|
|
53
|
+
<ul class="tsd-breadcrumb">
|
|
54
|
+
<li>
|
|
55
|
+
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="../modules/services.html">services</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="services.TCPEdgePolicyModule.html">TCPEdgePolicyModule</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Class TCPEdgePolicyModule</h1>
|
|
65
|
+
</div>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
<div class="container container-main">
|
|
69
|
+
<div class="row">
|
|
70
|
+
<div class="col-8 col-content">
|
|
71
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
72
|
+
<h3>Hierarchy</h3>
|
|
73
|
+
<ul class="tsd-hierarchy">
|
|
74
|
+
<li>
|
|
75
|
+
<span class="target">TCPEdgePolicyModule</span>
|
|
76
|
+
</li>
|
|
77
|
+
</ul>
|
|
78
|
+
</section>
|
|
79
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
80
|
+
<h2>Index</h2>
|
|
81
|
+
<section class="tsd-panel tsd-index-panel">
|
|
82
|
+
<div class="tsd-index-content">
|
|
83
|
+
<section class="tsd-index-section ">
|
|
84
|
+
<h3>Constructors</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.TCPEdgePolicyModule.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
87
|
+
</ul>
|
|
88
|
+
</section>
|
|
89
|
+
<section class="tsd-index-section ">
|
|
90
|
+
<h3>Methods</h3>
|
|
91
|
+
<ul class="tsd-index-list">
|
|
92
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgePolicyModule.html#delete" class="tsd-kind-icon">delete</a></li>
|
|
93
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgePolicyModule.html#get" class="tsd-kind-icon">get</a></li>
|
|
94
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgePolicyModule.html#replace" class="tsd-kind-icon">replace</a></li>
|
|
95
|
+
</ul>
|
|
96
|
+
</section>
|
|
97
|
+
</div>
|
|
98
|
+
</section>
|
|
99
|
+
</section>
|
|
100
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
101
|
+
<h2>Constructors</h2>
|
|
102
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
103
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
104
|
+
<h3>constructor</h3>
|
|
105
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
106
|
+
<li class="tsd-signature tsd-kind-icon">new TCPEdge<wbr>Policy<wbr>Module<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.TCPEdgePolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgePolicyModule</a></li>
|
|
107
|
+
</ul>
|
|
108
|
+
<ul class="tsd-descriptions">
|
|
109
|
+
<li class="tsd-description">
|
|
110
|
+
<aside class="tsd-sources">
|
|
111
|
+
<ul>
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2165">services.ts:2165</a></li>
|
|
113
|
+
</ul>
|
|
114
|
+
</aside>
|
|
115
|
+
<div class="tsd-comment tsd-typography">
|
|
116
|
+
<div class="lead">
|
|
117
|
+
<p>Do not construct this object directly, use the <code>tcpEdgePolicyModule</code> property of an <code>Ngrok</code> client object instead.</p>
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
121
|
+
<ul class="tsd-parameters">
|
|
122
|
+
<li>
|
|
123
|
+
<h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
|
|
124
|
+
</li>
|
|
125
|
+
</ul>
|
|
126
|
+
<h4 class="tsd-returns-title">Returns <a href="services.TCPEdgePolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgePolicyModule</a></h4>
|
|
127
|
+
</li>
|
|
128
|
+
</ul>
|
|
129
|
+
</section>
|
|
130
|
+
</section>
|
|
131
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
132
|
+
<h2>Methods</h2>
|
|
133
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
134
|
+
<a name="delete" class="tsd-anchor"></a>
|
|
135
|
+
<h3>delete</h3>
|
|
136
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
137
|
+
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
138
|
+
</ul>
|
|
139
|
+
<ul class="tsd-descriptions">
|
|
140
|
+
<li class="tsd-description">
|
|
141
|
+
<aside class="tsd-sources">
|
|
142
|
+
<ul>
|
|
143
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2184">services.ts:2184</a></li>
|
|
144
|
+
</ul>
|
|
145
|
+
</aside>
|
|
146
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
147
|
+
<ul class="tsd-parameters">
|
|
148
|
+
<li>
|
|
149
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
150
|
+
</li>
|
|
151
|
+
</ul>
|
|
152
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
153
|
+
</li>
|
|
154
|
+
</ul>
|
|
155
|
+
</section>
|
|
156
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
157
|
+
<a name="get" class="tsd-anchor"></a>
|
|
158
|
+
<h3>get</h3>
|
|
159
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
160
|
+
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointPolicy</a><span class="tsd-signature-symbol">></span></li>
|
|
161
|
+
</ul>
|
|
162
|
+
<ul class="tsd-descriptions">
|
|
163
|
+
<li class="tsd-description">
|
|
164
|
+
<aside class="tsd-sources">
|
|
165
|
+
<ul>
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2177">services.ts:2177</a></li>
|
|
167
|
+
</ul>
|
|
168
|
+
</aside>
|
|
169
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
170
|
+
<ul class="tsd-parameters">
|
|
171
|
+
<li>
|
|
172
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
173
|
+
</li>
|
|
174
|
+
</ul>
|
|
175
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointPolicy</a><span class="tsd-signature-symbol">></span></h4>
|
|
176
|
+
</li>
|
|
177
|
+
</ul>
|
|
178
|
+
</section>
|
|
179
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
180
|
+
<a name="replace" class="tsd-anchor"></a>
|
|
181
|
+
<h3>replace</h3>
|
|
182
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
183
|
+
<li class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EdgePolicyReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgePolicyReplace</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointPolicy</a><span class="tsd-signature-symbol">></span></li>
|
|
184
|
+
</ul>
|
|
185
|
+
<ul class="tsd-descriptions">
|
|
186
|
+
<li class="tsd-description">
|
|
187
|
+
<aside class="tsd-sources">
|
|
188
|
+
<ul>
|
|
189
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2168">services.ts:2168</a></li>
|
|
190
|
+
</ul>
|
|
191
|
+
</aside>
|
|
192
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
193
|
+
<ul class="tsd-parameters">
|
|
194
|
+
<li>
|
|
195
|
+
<h5>arg: <a href="../interfaces/datatypes.EdgePolicyReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgePolicyReplace</a></h5>
|
|
196
|
+
</li>
|
|
197
|
+
</ul>
|
|
198
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointPolicy</a><span class="tsd-signature-symbol">></span></h4>
|
|
199
|
+
</li>
|
|
200
|
+
</ul>
|
|
201
|
+
</section>
|
|
202
|
+
</section>
|
|
203
|
+
</div>
|
|
204
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
205
|
+
<nav class="tsd-navigation primary">
|
|
206
|
+
<ul>
|
|
207
|
+
<li class=" ">
|
|
208
|
+
<a href="../modules.html">Modules</a>
|
|
209
|
+
</li>
|
|
210
|
+
<li class=" tsd-kind-module">
|
|
211
|
+
<a href="../modules/client.html">client</a>
|
|
212
|
+
</li>
|
|
213
|
+
<li class=" tsd-kind-module">
|
|
214
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
215
|
+
</li>
|
|
216
|
+
<li class="current tsd-kind-module">
|
|
217
|
+
<a href="../modules/services.html">services</a>
|
|
218
|
+
</li>
|
|
219
|
+
</ul>
|
|
220
|
+
</nav>
|
|
221
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
222
|
+
<ul class="before-current">
|
|
223
|
+
</ul>
|
|
224
|
+
<ul class="current">
|
|
225
|
+
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
226
|
+
<a href="services.TCPEdgePolicyModule.html" class="tsd-kind-icon">TCPEdge<wbr>Policy<wbr>Module</a>
|
|
227
|
+
<ul>
|
|
228
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
229
|
+
<a href="services.TCPEdgePolicyModule.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
230
|
+
</li>
|
|
231
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
232
|
+
<a href="services.TCPEdgePolicyModule.html#delete" class="tsd-kind-icon">delete</a>
|
|
233
|
+
</li>
|
|
234
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
235
|
+
<a href="services.TCPEdgePolicyModule.html#get" class="tsd-kind-icon">get</a>
|
|
236
|
+
</li>
|
|
237
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
238
|
+
<a href="services.TCPEdgePolicyModule.html#replace" class="tsd-kind-icon">replace</a>
|
|
239
|
+
</li>
|
|
240
|
+
</ul>
|
|
241
|
+
</li>
|
|
242
|
+
</ul>
|
|
243
|
+
<ul class="after-current">
|
|
244
|
+
</ul>
|
|
245
|
+
</nav>
|
|
246
|
+
</div>
|
|
247
|
+
</div>
|
|
248
|
+
</div>
|
|
249
|
+
<footer class="with-border-bottom">
|
|
250
|
+
<div class="container">
|
|
251
|
+
<h2>Legend</h2>
|
|
252
|
+
<div class="tsd-legend-group">
|
|
253
|
+
<ul class="tsd-legend">
|
|
254
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
255
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
256
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
257
|
+
</ul>
|
|
258
|
+
<ul class="tsd-legend">
|
|
259
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
260
|
+
</ul>
|
|
261
|
+
</div>
|
|
262
|
+
</div>
|
|
263
|
+
</footer>
|
|
264
|
+
<div class="container tsd-generator">
|
|
265
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
266
|
+
</div>
|
|
267
|
+
<div class="overlay"></div>
|
|
268
|
+
<script src="../assets/js/main.js"></script>
|
|
269
|
+
</body>
|
|
270
|
+
</html>
|
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>TCPEdgeTrafficPolicyModule | @ngrok/ngrok-api</title>
|
|
7
|
+
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<div class="tsd-page-toolbar">
|
|
15
|
+
<div class="container">
|
|
16
|
+
<div class="table-wrap">
|
|
17
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
+
<div class="field">
|
|
19
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
+
<input id="tsd-search-field" type="text" />
|
|
21
|
+
</div>
|
|
22
|
+
<ul class="results">
|
|
23
|
+
<li class="state loading">Preparing search index...</li>
|
|
24
|
+
<li class="state failure">The search index is not available</li>
|
|
25
|
+
</ul>
|
|
26
|
+
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="table-cell" id="tsd-widgets">
|
|
29
|
+
<div id="tsd-filter">
|
|
30
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
+
<div class="tsd-filter-group">
|
|
32
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
+
<span class="tsd-select-label">All</span>
|
|
34
|
+
<ul class="tsd-select-list">
|
|
35
|
+
<li data-value="public">Public</li>
|
|
36
|
+
<li data-value="protected">Public/Protected</li>
|
|
37
|
+
<li data-value="private" class="selected">All</li>
|
|
38
|
+
</ul>
|
|
39
|
+
</div>
|
|
40
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-page-title">
|
|
52
|
+
<div class="container">
|
|
53
|
+
<ul class="tsd-breadcrumb">
|
|
54
|
+
<li>
|
|
55
|
+
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="../modules/services.html">services</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="services.TCPEdgeTrafficPolicyModule.html">TCPEdgeTrafficPolicyModule</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Class TCPEdgeTrafficPolicyModule</h1>
|
|
65
|
+
</div>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
<div class="container container-main">
|
|
69
|
+
<div class="row">
|
|
70
|
+
<div class="col-8 col-content">
|
|
71
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
72
|
+
<h3>Hierarchy</h3>
|
|
73
|
+
<ul class="tsd-hierarchy">
|
|
74
|
+
<li>
|
|
75
|
+
<span class="target">TCPEdgeTrafficPolicyModule</span>
|
|
76
|
+
</li>
|
|
77
|
+
</ul>
|
|
78
|
+
</section>
|
|
79
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
80
|
+
<h2>Index</h2>
|
|
81
|
+
<section class="tsd-panel tsd-index-panel">
|
|
82
|
+
<div class="tsd-index-content">
|
|
83
|
+
<section class="tsd-index-section ">
|
|
84
|
+
<h3>Constructors</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.TCPEdgeTrafficPolicyModule.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
87
|
+
</ul>
|
|
88
|
+
</section>
|
|
89
|
+
<section class="tsd-index-section ">
|
|
90
|
+
<h3>Methods</h3>
|
|
91
|
+
<ul class="tsd-index-list">
|
|
92
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgeTrafficPolicyModule.html#delete" class="tsd-kind-icon">delete</a></li>
|
|
93
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgeTrafficPolicyModule.html#get" class="tsd-kind-icon">get</a></li>
|
|
94
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgeTrafficPolicyModule.html#replace" class="tsd-kind-icon">replace</a></li>
|
|
95
|
+
</ul>
|
|
96
|
+
</section>
|
|
97
|
+
</div>
|
|
98
|
+
</section>
|
|
99
|
+
</section>
|
|
100
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
101
|
+
<h2>Constructors</h2>
|
|
102
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
103
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
104
|
+
<h3>constructor</h3>
|
|
105
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
106
|
+
<li class="tsd-signature tsd-kind-icon">new TCPEdge<wbr>Traffic<wbr>Policy<wbr>Module<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeTrafficPolicyModule</a></li>
|
|
107
|
+
</ul>
|
|
108
|
+
<ul class="tsd-descriptions">
|
|
109
|
+
<li class="tsd-description">
|
|
110
|
+
<aside class="tsd-sources">
|
|
111
|
+
<ul>
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2167">services.ts:2167</a></li>
|
|
113
|
+
</ul>
|
|
114
|
+
</aside>
|
|
115
|
+
<div class="tsd-comment tsd-typography">
|
|
116
|
+
<div class="lead">
|
|
117
|
+
<p>Do not construct this object directly, use the <code>tcpEdgeTrafficPolicyModule</code> property of an <code>Ngrok</code> client object instead.</p>
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
121
|
+
<ul class="tsd-parameters">
|
|
122
|
+
<li>
|
|
123
|
+
<h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
|
|
124
|
+
</li>
|
|
125
|
+
</ul>
|
|
126
|
+
<h4 class="tsd-returns-title">Returns <a href="services.TCPEdgeTrafficPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeTrafficPolicyModule</a></h4>
|
|
127
|
+
</li>
|
|
128
|
+
</ul>
|
|
129
|
+
</section>
|
|
130
|
+
</section>
|
|
131
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
132
|
+
<h2>Methods</h2>
|
|
133
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
134
|
+
<a name="delete" class="tsd-anchor"></a>
|
|
135
|
+
<h3>delete</h3>
|
|
136
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
137
|
+
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
138
|
+
</ul>
|
|
139
|
+
<ul class="tsd-descriptions">
|
|
140
|
+
<li class="tsd-description">
|
|
141
|
+
<aside class="tsd-sources">
|
|
142
|
+
<ul>
|
|
143
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2186">services.ts:2186</a></li>
|
|
144
|
+
</ul>
|
|
145
|
+
</aside>
|
|
146
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
147
|
+
<ul class="tsd-parameters">
|
|
148
|
+
<li>
|
|
149
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
150
|
+
</li>
|
|
151
|
+
</ul>
|
|
152
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
153
|
+
</li>
|
|
154
|
+
</ul>
|
|
155
|
+
</section>
|
|
156
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
157
|
+
<a name="get" class="tsd-anchor"></a>
|
|
158
|
+
<h3>get</h3>
|
|
159
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
160
|
+
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointTrafficPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTrafficPolicy</a><span class="tsd-signature-symbol">></span></li>
|
|
161
|
+
</ul>
|
|
162
|
+
<ul class="tsd-descriptions">
|
|
163
|
+
<li class="tsd-description">
|
|
164
|
+
<aside class="tsd-sources">
|
|
165
|
+
<ul>
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2179">services.ts:2179</a></li>
|
|
167
|
+
</ul>
|
|
168
|
+
</aside>
|
|
169
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
170
|
+
<ul class="tsd-parameters">
|
|
171
|
+
<li>
|
|
172
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
173
|
+
</li>
|
|
174
|
+
</ul>
|
|
175
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointTrafficPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTrafficPolicy</a><span class="tsd-signature-symbol">></span></h4>
|
|
176
|
+
</li>
|
|
177
|
+
</ul>
|
|
178
|
+
</section>
|
|
179
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
180
|
+
<a name="replace" class="tsd-anchor"></a>
|
|
181
|
+
<h3>replace</h3>
|
|
182
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
183
|
+
<li class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EdgeTrafficPolicyReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeTrafficPolicyReplace</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointTrafficPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTrafficPolicy</a><span class="tsd-signature-symbol">></span></li>
|
|
184
|
+
</ul>
|
|
185
|
+
<ul class="tsd-descriptions">
|
|
186
|
+
<li class="tsd-description">
|
|
187
|
+
<aside class="tsd-sources">
|
|
188
|
+
<ul>
|
|
189
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2170">services.ts:2170</a></li>
|
|
190
|
+
</ul>
|
|
191
|
+
</aside>
|
|
192
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
193
|
+
<ul class="tsd-parameters">
|
|
194
|
+
<li>
|
|
195
|
+
<h5>arg: <a href="../interfaces/datatypes.EdgeTrafficPolicyReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeTrafficPolicyReplace</a></h5>
|
|
196
|
+
</li>
|
|
197
|
+
</ul>
|
|
198
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointTrafficPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTrafficPolicy</a><span class="tsd-signature-symbol">></span></h4>
|
|
199
|
+
</li>
|
|
200
|
+
</ul>
|
|
201
|
+
</section>
|
|
202
|
+
</section>
|
|
203
|
+
</div>
|
|
204
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
205
|
+
<nav class="tsd-navigation primary">
|
|
206
|
+
<ul>
|
|
207
|
+
<li class=" ">
|
|
208
|
+
<a href="../modules.html">Modules</a>
|
|
209
|
+
</li>
|
|
210
|
+
<li class=" tsd-kind-module">
|
|
211
|
+
<a href="../modules/client.html">client</a>
|
|
212
|
+
</li>
|
|
213
|
+
<li class=" tsd-kind-module">
|
|
214
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
215
|
+
</li>
|
|
216
|
+
<li class="current tsd-kind-module">
|
|
217
|
+
<a href="../modules/services.html">services</a>
|
|
218
|
+
</li>
|
|
219
|
+
</ul>
|
|
220
|
+
</nav>
|
|
221
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
222
|
+
<ul class="before-current">
|
|
223
|
+
</ul>
|
|
224
|
+
<ul class="current">
|
|
225
|
+
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
226
|
+
<a href="services.TCPEdgeTrafficPolicyModule.html" class="tsd-kind-icon">TCPEdge<wbr>Traffic<wbr>Policy<wbr>Module</a>
|
|
227
|
+
<ul>
|
|
228
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
229
|
+
<a href="services.TCPEdgeTrafficPolicyModule.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
230
|
+
</li>
|
|
231
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
232
|
+
<a href="services.TCPEdgeTrafficPolicyModule.html#delete" class="tsd-kind-icon">delete</a>
|
|
233
|
+
</li>
|
|
234
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
235
|
+
<a href="services.TCPEdgeTrafficPolicyModule.html#get" class="tsd-kind-icon">get</a>
|
|
236
|
+
</li>
|
|
237
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
238
|
+
<a href="services.TCPEdgeTrafficPolicyModule.html#replace" class="tsd-kind-icon">replace</a>
|
|
239
|
+
</li>
|
|
240
|
+
</ul>
|
|
241
|
+
</li>
|
|
242
|
+
</ul>
|
|
243
|
+
<ul class="after-current">
|
|
244
|
+
</ul>
|
|
245
|
+
</nav>
|
|
246
|
+
</div>
|
|
247
|
+
</div>
|
|
248
|
+
</div>
|
|
249
|
+
<footer class="with-border-bottom">
|
|
250
|
+
<div class="container">
|
|
251
|
+
<h2>Legend</h2>
|
|
252
|
+
<div class="tsd-legend-group">
|
|
253
|
+
<ul class="tsd-legend">
|
|
254
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
255
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
256
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
257
|
+
</ul>
|
|
258
|
+
<ul class="tsd-legend">
|
|
259
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
260
|
+
</ul>
|
|
261
|
+
</div>
|
|
262
|
+
</div>
|
|
263
|
+
</footer>
|
|
264
|
+
<div class="container tsd-generator">
|
|
265
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
266
|
+
</div>
|
|
267
|
+
<div class="overlay"></div>
|
|
268
|
+
<script src="../assets/js/main.js"></script>
|
|
269
|
+
</body>
|
|
270
|
+
</html>
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
<li class="tsd-description">
|
|
123
123
|
<aside class="tsd-sources">
|
|
124
124
|
<ul>
|
|
125
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
125
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L3797">services.ts:3797</a></li>
|
|
126
126
|
</ul>
|
|
127
127
|
</aside>
|
|
128
128
|
<div class="tsd-comment tsd-typography">
|
|
@@ -153,7 +153,7 @@
|
|
|
153
153
|
<li class="tsd-description">
|
|
154
154
|
<aside class="tsd-sources">
|
|
155
155
|
<ul>
|
|
156
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
156
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L3803">services.ts:3803</a></li>
|
|
157
157
|
</ul>
|
|
158
158
|
</aside>
|
|
159
159
|
<div class="tsd-comment tsd-typography">
|
|
@@ -181,7 +181,7 @@
|
|
|
181
181
|
<li class="tsd-description">
|
|
182
182
|
<aside class="tsd-sources">
|
|
183
183
|
<ul>
|
|
184
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
184
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L3815">services.ts:3815</a></li>
|
|
185
185
|
</ul>
|
|
186
186
|
</aside>
|
|
187
187
|
<div class="tsd-comment tsd-typography">
|
|
@@ -209,7 +209,7 @@
|
|
|
209
209
|
<li class="tsd-description">
|
|
210
210
|
<aside class="tsd-sources">
|
|
211
211
|
<ul>
|
|
212
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
212
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L3825">services.ts:3825</a></li>
|
|
213
213
|
</ul>
|
|
214
214
|
</aside>
|
|
215
215
|
<div class="tsd-comment tsd-typography">
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
<li class="tsd-description">
|
|
238
238
|
<aside class="tsd-sources">
|
|
239
239
|
<ul>
|
|
240
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
240
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L3835">services.ts:3835</a></li>
|
|
241
241
|
</ul>
|
|
242
242
|
</aside>
|
|
243
243
|
<div class="tsd-comment tsd-typography">
|
|
@@ -268,7 +268,7 @@
|
|
|
268
268
|
<li class="tsd-description">
|
|
269
269
|
<aside class="tsd-sources">
|
|
270
270
|
<ul>
|
|
271
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
271
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L3885">services.ts:3885</a></li>
|
|
272
272
|
</ul>
|
|
273
273
|
</aside>
|
|
274
274
|
<div class="tsd-comment tsd-typography">
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<li class="tsd-description">
|
|
110
110
|
<aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2296">services.ts:2296</a></li>
|
|
113
113
|
</ul>
|
|
114
114
|
</aside>
|
|
115
115
|
<div class="tsd-comment tsd-typography">
|
|
@@ -140,7 +140,7 @@
|
|
|
140
140
|
<li class="tsd-description">
|
|
141
141
|
<aside class="tsd-sources">
|
|
142
142
|
<ul>
|
|
143
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
143
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2315">services.ts:2315</a></li>
|
|
144
144
|
</ul>
|
|
145
145
|
</aside>
|
|
146
146
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -163,7 +163,7 @@
|
|
|
163
163
|
<li class="tsd-description">
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2308">services.ts:2308</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
<li class="tsd-description">
|
|
187
187
|
<aside class="tsd-sources">
|
|
188
188
|
<ul>
|
|
189
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
189
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/services.ts#L2299">services.ts:2299</a></li>
|
|
190
190
|
</ul>
|
|
191
191
|
</aside>
|
|
192
192
|
<h4 class="tsd-parameters-title">Parameters</h4>
|