From ebc1c61cbb037ef61d487bd6d494a366327058ea Mon Sep 17 00:00:00 2001 From: Andrew Haines Date: Tue, 26 Nov 2024 20:51:55 +0000 Subject: [PATCH] Add missing blank lines in docs Signed-off-by: Andrew Haines --- docs/core.auditlogfilterisbetween.md | 1 + docs/core.auditlogfilterissince.md | 1 + docs/core.auditlogfilteristail.md | 1 + docs/core.checkresourcesresponse.allallowed.md | 1 + docs/core.checkresourcesresponse.allowedactions.md | 1 + docs/core.checkresourcesresponse.findresult.md | 1 + docs/core.checkresourcesresponse.isallowed.md | 1 + docs/core.checkresourcesresult.allallowed.md | 1 + docs/core.checkresourcesresult.allowedactions.md | 1 + docs/core.checkresourcesresult.isallowed.md | 1 + docs/core.checkresourcesresult.output.md | 1 + docs/core.client.addorupdatepolicies.md | 1 + docs/core.client.addorupdateschemas.md | 1 + docs/core.client.checkresource.md | 1 + docs/core.client.checkresources.md | 1 + docs/core.client.deleteschema.md | 1 + docs/core.client.deleteschemas.md | 1 + docs/core.client.disablepolicies.md | 1 + docs/core.client.disablepolicy.md | 1 + docs/core.client.enablepolicies.md | 1 + docs/core.client.enablepolicy.md | 1 + docs/core.client.getaccesslogentry.md | 1 + docs/core.client.getdecisionlogentry.md | 1 + docs/core.client.getpolicies.md | 1 + docs/core.client.getpolicy.md | 1 + docs/core.client.getschema.md | 1 + docs/core.client.getschemas.md | 1 + docs/core.client.inspectpolicies.md | 1 + docs/core.client.isallowed.md | 1 + docs/core.client.listaccesslogentries.md | 1 + docs/core.client.listdecisionlogentries.md | 1 + docs/core.client.listpolicies.md | 1 + docs/core.client.listschemas.md | 1 + docs/core.client.planresources.md | 1 + docs/core.client.reloadstore.md | 1 + docs/core.client.serverinfo.md | 1 + docs/core.client.withprincipal.md | 1 + docs/core.clientwithprincipal.checkresource.md | 1 + docs/core.clientwithprincipal.checkresources.md | 1 + docs/core.clientwithprincipal.isallowed.md | 1 + docs/core.clientwithprincipal.planresources.md | 1 + docs/core.decisionlogentrymethodischeckresources.md | 1 + docs/core.decisionlogentrymethodisplanresources.md | 1 + docs/core.matchismatchall.md | 1 + docs/core.matchismatchany.md | 1 + docs/core.matchismatchexpr.md | 1 + docs/core.matchismatchnone.md | 1 + docs/core.notok.fromjson.md | 1 + docs/core.planresourcesoutputisconditional.md | 1 + docs/core.planresourcesoutputisunconditional.md | 1 + docs/core.planresourcesresponseisconditional.md | 1 + docs/core.planresourcesresponseisunconditional.md | 1 + docs/core.policyisderivedroles.md | 1 + docs/core.policyisexportconstants.md | 1 + docs/core.policyisexportvariables.md | 1 + docs/core.policyisprincipalpolicy.md | 1 + docs/core.policyisresourcepolicy.md | 1 + docs/core.policyisrolepolicy.md | 1 + docs/core.schemadefinition.toobject.md | 1 + docs/core.schemadefinition.tostring.md | 1 + docs/embedded.autoupdatingloader.activate.md | 1 + docs/embedded.autoupdatingloader.stop.md | 1 + docs/embedded.loader.active.md | 1 + docs/files.parsepolicy.md | 1 + docs/files.readdirectory.md | 1 + docs/files.readpolicy.md | 1 + docs/files.readschema.md | 1 + docs/grpc.grpc.close.md | 1 + docs/opentelemetry.cerbosinstrumentation.disable.md | 1 + docs/opentelemetry.cerbosinstrumentation.enable.md | 1 + docs/opentelemetry.cerbosinstrumentation.getconfig.md | 1 + docs/opentelemetry.cerbosinstrumentation.setconfig.md | 1 + docs/opentelemetry.cerbosinstrumentation.setmeterprovider.md | 1 + docs/opentelemetry.cerbosinstrumentation.settracerprovider.md | 1 + docs/react.cerbosprovider.md | 1 + docs/react.usecerbos.md | 1 + docs/react.usecheckresource.md | 1 + docs/react.usecheckresources.md | 1 + docs/react.useisallowed.md | 1 + package.json | 2 +- 80 files changed, 80 insertions(+), 1 deletion(-) diff --git a/docs/core.auditlogfilterisbetween.md b/docs/core.auditlogfilterisbetween.md index 606c3c9b..0ad33f13 100644 --- a/docs/core.auditlogfilterisbetween.md +++ b/docs/core.auditlogfilterisbetween.md @@ -45,6 +45,7 @@ filter + **Returns:** filter is [AuditLogFilterBetween](./core.auditlogfilterbetween.md) diff --git a/docs/core.auditlogfilterissince.md b/docs/core.auditlogfilterissince.md index 489ae2b8..9437f24f 100644 --- a/docs/core.auditlogfilterissince.md +++ b/docs/core.auditlogfilterissince.md @@ -45,6 +45,7 @@ filter + **Returns:** filter is [AuditLogFilterSince](./core.auditlogfiltersince.md) diff --git a/docs/core.auditlogfilteristail.md b/docs/core.auditlogfilteristail.md index 52dcd0d0..9ed86983 100644 --- a/docs/core.auditlogfilteristail.md +++ b/docs/core.auditlogfilteristail.md @@ -45,6 +45,7 @@ filter + **Returns:** filter is [AuditLogFilterTail](./core.auditlogfiltertail.md) diff --git a/docs/core.checkresourcesresponse.allallowed.md b/docs/core.checkresourcesresponse.allallowed.md index 83ba46a5..30f5988f 100644 --- a/docs/core.checkresourcesresponse.allallowed.md +++ b/docs/core.checkresourcesresponse.allallowed.md @@ -47,6 +47,7 @@ the resource search criteria. + **Returns:** boolean \| undefined diff --git a/docs/core.checkresourcesresponse.allowedactions.md b/docs/core.checkresourcesresponse.allowedactions.md index ec902863..eae9a4d1 100644 --- a/docs/core.checkresourcesresponse.allowedactions.md +++ b/docs/core.checkresourcesresponse.allowedactions.md @@ -47,6 +47,7 @@ the resource search criteria. + **Returns:** string\[\] \| undefined diff --git a/docs/core.checkresourcesresponse.findresult.md b/docs/core.checkresourcesresponse.findresult.md index acc740f7..fa503b2f 100644 --- a/docs/core.checkresourcesresponse.findresult.md +++ b/docs/core.checkresourcesresponse.findresult.md @@ -47,6 +47,7 @@ the resource search criteria. + **Returns:** [CheckResourcesResult](./core.checkresourcesresult.md) \| undefined diff --git a/docs/core.checkresourcesresponse.isallowed.md b/docs/core.checkresourcesresponse.isallowed.md index ad37d430..b8e029dd 100644 --- a/docs/core.checkresourcesresponse.isallowed.md +++ b/docs/core.checkresourcesresponse.isallowed.md @@ -50,6 +50,7 @@ the resource search criteria and action to check. + **Returns:** boolean \| undefined diff --git a/docs/core.checkresourcesresult.allallowed.md b/docs/core.checkresourcesresult.allallowed.md index c2d32a86..f9c1c558 100644 --- a/docs/core.checkresourcesresult.allallowed.md +++ b/docs/core.checkresourcesresult.allallowed.md @@ -11,6 +11,7 @@ Check if the policy decision was that all input actions should be allowed for th ```typescript allAllowed(): boolean; ``` + **Returns:** boolean diff --git a/docs/core.checkresourcesresult.allowedactions.md b/docs/core.checkresourcesresult.allowedactions.md index 1d2d3dc9..504cb432 100644 --- a/docs/core.checkresourcesresult.allowedactions.md +++ b/docs/core.checkresourcesresult.allowedactions.md @@ -11,6 +11,7 @@ List the actions that should be allowed for the resource. ```typescript allowedActions(): string[]; ``` + **Returns:** string\[\] diff --git a/docs/core.checkresourcesresult.isallowed.md b/docs/core.checkresourcesresult.isallowed.md index 1ed42962..2a51f947 100644 --- a/docs/core.checkresourcesresult.isallowed.md +++ b/docs/core.checkresourcesresult.isallowed.md @@ -47,6 +47,7 @@ the action to check. + **Returns:** boolean \| undefined diff --git a/docs/core.checkresourcesresult.output.md b/docs/core.checkresourcesresult.output.md index 6ab50008..833b9f04 100644 --- a/docs/core.checkresourcesresult.output.md +++ b/docs/core.checkresourcesresult.output.md @@ -47,6 +47,7 @@ the identifier of the policy rule that produced the output. + **Returns:** [Value](./core.value.md) \| undefined diff --git a/docs/core.client.addorupdatepolicies.md b/docs/core.client.addorupdatepolicies.md index a5b8917c..5a0d1939 100644 --- a/docs/core.client.addorupdatepolicies.md +++ b/docs/core.client.addorupdatepolicies.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<void> diff --git a/docs/core.client.addorupdateschemas.md b/docs/core.client.addorupdateschemas.md index 9bb63a5e..087b7469 100644 --- a/docs/core.client.addorupdateschemas.md +++ b/docs/core.client.addorupdateschemas.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<void> diff --git a/docs/core.client.checkresource.md b/docs/core.client.checkresource.md index 785d3612..3aa895d6 100644 --- a/docs/core.client.checkresource.md +++ b/docs/core.client.checkresource.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[CheckResourcesResult](./core.checkresourcesresult.md)> diff --git a/docs/core.client.checkresources.md b/docs/core.client.checkresources.md index 2b37db1a..72f0ccb2 100644 --- a/docs/core.client.checkresources.md +++ b/docs/core.client.checkresources.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[CheckResourcesResponse](./core.checkresourcesresponse.md)> diff --git a/docs/core.client.deleteschema.md b/docs/core.client.deleteschema.md index d7c5c837..76a6045a 100644 --- a/docs/core.client.deleteschema.md +++ b/docs/core.client.deleteschema.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<boolean> diff --git a/docs/core.client.deleteschemas.md b/docs/core.client.deleteschemas.md index 7bf2253b..2d7eed74 100644 --- a/docs/core.client.deleteschemas.md +++ b/docs/core.client.deleteschemas.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[DeleteSchemasResponse](./core.deleteschemasresponse.md)> diff --git a/docs/core.client.disablepolicies.md b/docs/core.client.disablepolicies.md index 7866cefc..a468ec81 100644 --- a/docs/core.client.disablepolicies.md +++ b/docs/core.client.disablepolicies.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[DisablePoliciesResponse](./core.disablepoliciesresponse.md)> diff --git a/docs/core.client.disablepolicy.md b/docs/core.client.disablepolicy.md index fb0c689b..82d7b9f3 100644 --- a/docs/core.client.disablepolicy.md +++ b/docs/core.client.disablepolicy.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<boolean> diff --git a/docs/core.client.enablepolicies.md b/docs/core.client.enablepolicies.md index a7bfafa8..d6d7b999 100644 --- a/docs/core.client.enablepolicies.md +++ b/docs/core.client.enablepolicies.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[EnablePoliciesResponse](./core.enablepoliciesresponse.md)> diff --git a/docs/core.client.enablepolicy.md b/docs/core.client.enablepolicy.md index 40be08d8..9ef380bc 100644 --- a/docs/core.client.enablepolicy.md +++ b/docs/core.client.enablepolicy.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<boolean> diff --git a/docs/core.client.getaccesslogentry.md b/docs/core.client.getaccesslogentry.md index b82be70c..db04e958 100644 --- a/docs/core.client.getaccesslogentry.md +++ b/docs/core.client.getaccesslogentry.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[AccessLogEntry](./core.accesslogentry.md) \| undefined> diff --git a/docs/core.client.getdecisionlogentry.md b/docs/core.client.getdecisionlogentry.md index f0277cc5..73366d61 100644 --- a/docs/core.client.getdecisionlogentry.md +++ b/docs/core.client.getdecisionlogentry.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[DecisionLogEntry](./core.decisionlogentry.md) \| undefined> diff --git a/docs/core.client.getpolicies.md b/docs/core.client.getpolicies.md index c19bf785..4be70373 100644 --- a/docs/core.client.getpolicies.md +++ b/docs/core.client.getpolicies.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[GetPoliciesResponse](./core.getpoliciesresponse.md)> diff --git a/docs/core.client.getpolicy.md b/docs/core.client.getpolicy.md index 41df56dc..2a7bb915 100644 --- a/docs/core.client.getpolicy.md +++ b/docs/core.client.getpolicy.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[Policy](./core.policy.md) \| undefined> diff --git a/docs/core.client.getschema.md b/docs/core.client.getschema.md index 769c1603..03c959a3 100644 --- a/docs/core.client.getschema.md +++ b/docs/core.client.getschema.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[Schema](./core.schema.md) \| undefined> diff --git a/docs/core.client.getschemas.md b/docs/core.client.getschemas.md index 34ed0140..cf7de35e 100644 --- a/docs/core.client.getschemas.md +++ b/docs/core.client.getschemas.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[GetSchemasResponse](./core.getschemasresponse.md)> diff --git a/docs/core.client.inspectpolicies.md b/docs/core.client.inspectpolicies.md index 3d7b9afd..0098990b 100644 --- a/docs/core.client.inspectpolicies.md +++ b/docs/core.client.inspectpolicies.md @@ -63,6 +63,7 @@ _(Optional)_ + **Returns:** Promise<[InspectPoliciesResponse](./core.inspectpoliciesresponse.md)> diff --git a/docs/core.client.isallowed.md b/docs/core.client.isallowed.md index 46703116..3a277d09 100644 --- a/docs/core.client.isallowed.md +++ b/docs/core.client.isallowed.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<boolean> diff --git a/docs/core.client.listaccesslogentries.md b/docs/core.client.listaccesslogentries.md index 560d18a5..a4c775c9 100644 --- a/docs/core.client.listaccesslogentries.md +++ b/docs/core.client.listaccesslogentries.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** AsyncGenerator<[AccessLogEntry](./core.accesslogentry.md), void, undefined> diff --git a/docs/core.client.listdecisionlogentries.md b/docs/core.client.listdecisionlogentries.md index 1386b543..5261cc0c 100644 --- a/docs/core.client.listdecisionlogentries.md +++ b/docs/core.client.listdecisionlogentries.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** AsyncGenerator<[DecisionLogEntry](./core.decisionlogentry.md), void, undefined> diff --git a/docs/core.client.listpolicies.md b/docs/core.client.listpolicies.md index 87763e63..c475bb54 100644 --- a/docs/core.client.listpolicies.md +++ b/docs/core.client.listpolicies.md @@ -63,6 +63,7 @@ _(Optional)_ + **Returns:** Promise<[ListPoliciesResponse](./core.listpoliciesresponse.md)> diff --git a/docs/core.client.listschemas.md b/docs/core.client.listschemas.md index 5e81134a..a0b73abc 100644 --- a/docs/core.client.listschemas.md +++ b/docs/core.client.listschemas.md @@ -47,6 +47,7 @@ _(Optional)_ + **Returns:** Promise<[ListSchemasResponse](./core.listschemasresponse.md)> diff --git a/docs/core.client.planresources.md b/docs/core.client.planresources.md index 9e924eda..648ea73e 100644 --- a/docs/core.client.planresources.md +++ b/docs/core.client.planresources.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[PlanResourcesResponse](./core.planresourcesresponse.md)> diff --git a/docs/core.client.reloadstore.md b/docs/core.client.reloadstore.md index 9f004717..d4e2bdc2 100644 --- a/docs/core.client.reloadstore.md +++ b/docs/core.client.reloadstore.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<void> diff --git a/docs/core.client.serverinfo.md b/docs/core.client.serverinfo.md index 7b4288df..6a2fc662 100644 --- a/docs/core.client.serverinfo.md +++ b/docs/core.client.serverinfo.md @@ -47,6 +47,7 @@ _(Optional)_ + **Returns:** Promise<[ServerInfo](./core.serverinfo.md)> diff --git a/docs/core.client.withprincipal.md b/docs/core.client.withprincipal.md index 61db5cba..2e5562c7 100644 --- a/docs/core.client.withprincipal.md +++ b/docs/core.client.withprincipal.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** [ClientWithPrincipal](./core.clientwithprincipal.md)<this> diff --git a/docs/core.clientwithprincipal.checkresource.md b/docs/core.clientwithprincipal.checkresource.md index 486a5004..b2cb9fd2 100644 --- a/docs/core.clientwithprincipal.checkresource.md +++ b/docs/core.clientwithprincipal.checkresource.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[CheckResourcesResult](./core.checkresourcesresult.md)> diff --git a/docs/core.clientwithprincipal.checkresources.md b/docs/core.clientwithprincipal.checkresources.md index f8de8eef..156d1353 100644 --- a/docs/core.clientwithprincipal.checkresources.md +++ b/docs/core.clientwithprincipal.checkresources.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[CheckResourcesResponse](./core.checkresourcesresponse.md)> diff --git a/docs/core.clientwithprincipal.isallowed.md b/docs/core.clientwithprincipal.isallowed.md index 4ba35e1b..9c20acbf 100644 --- a/docs/core.clientwithprincipal.isallowed.md +++ b/docs/core.clientwithprincipal.isallowed.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<boolean> diff --git a/docs/core.clientwithprincipal.planresources.md b/docs/core.clientwithprincipal.planresources.md index 11737600..fdf62d7d 100644 --- a/docs/core.clientwithprincipal.planresources.md +++ b/docs/core.clientwithprincipal.planresources.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** Promise<[PlanResourcesResponse](./core.planresourcesresponse.md)> diff --git a/docs/core.decisionlogentrymethodischeckresources.md b/docs/core.decisionlogentrymethodischeckresources.md index c19d6102..db8f0dad 100644 --- a/docs/core.decisionlogentrymethodischeckresources.md +++ b/docs/core.decisionlogentrymethodischeckresources.md @@ -45,6 +45,7 @@ method + **Returns:** method is [DecisionLogEntryCheckResources](./core.decisionlogentrycheckresources.md) diff --git a/docs/core.decisionlogentrymethodisplanresources.md b/docs/core.decisionlogentrymethodisplanresources.md index f44991fa..db6964be 100644 --- a/docs/core.decisionlogentrymethodisplanresources.md +++ b/docs/core.decisionlogentrymethodisplanresources.md @@ -45,6 +45,7 @@ method + **Returns:** method is [DecisionLogEntryPlanResources](./core.decisionlogentryplanresources.md) diff --git a/docs/core.matchismatchall.md b/docs/core.matchismatchall.md index 8d478f89..822cabda 100644 --- a/docs/core.matchismatchall.md +++ b/docs/core.matchismatchall.md @@ -45,6 +45,7 @@ match + **Returns:** match is [MatchAll](./core.matchall.md) diff --git a/docs/core.matchismatchany.md b/docs/core.matchismatchany.md index 0d3d93a1..fd1443e5 100644 --- a/docs/core.matchismatchany.md +++ b/docs/core.matchismatchany.md @@ -45,6 +45,7 @@ match + **Returns:** match is [MatchAny](./core.matchany.md) diff --git a/docs/core.matchismatchexpr.md b/docs/core.matchismatchexpr.md index 09b45cd5..c669f2ae 100644 --- a/docs/core.matchismatchexpr.md +++ b/docs/core.matchismatchexpr.md @@ -45,6 +45,7 @@ match + **Returns:** match is [MatchExpr](./core.matchexpr.md) diff --git a/docs/core.matchismatchnone.md b/docs/core.matchismatchnone.md index 466adb92..5c093e66 100644 --- a/docs/core.matchismatchnone.md +++ b/docs/core.matchismatchnone.md @@ -45,6 +45,7 @@ match + **Returns:** match is [MatchNone](./core.matchnone.md) diff --git a/docs/core.notok.fromjson.md b/docs/core.notok.fromjson.md index 7e5fbab1..00070b2a 100644 --- a/docs/core.notok.fromjson.md +++ b/docs/core.notok.fromjson.md @@ -45,6 +45,7 @@ string + **Returns:** [NotOK](./core.notok.md) diff --git a/docs/core.planresourcesoutputisconditional.md b/docs/core.planresourcesoutputisconditional.md index ba7001c3..36c40ac2 100644 --- a/docs/core.planresourcesoutputisconditional.md +++ b/docs/core.planresourcesoutputisconditional.md @@ -45,6 +45,7 @@ output + **Returns:** output is [PlanResourcesConditionalOutput](./core.planresourcesconditionaloutput.md) diff --git a/docs/core.planresourcesoutputisunconditional.md b/docs/core.planresourcesoutputisunconditional.md index 965e72df..eb5f6566 100644 --- a/docs/core.planresourcesoutputisunconditional.md +++ b/docs/core.planresourcesoutputisunconditional.md @@ -45,6 +45,7 @@ output + **Returns:** output is [PlanResourcesUnconditionalOutput](./core.planresourcesunconditionaloutput.md) diff --git a/docs/core.planresourcesresponseisconditional.md b/docs/core.planresourcesresponseisconditional.md index fb5c9272..03df7363 100644 --- a/docs/core.planresourcesresponseisconditional.md +++ b/docs/core.planresourcesresponseisconditional.md @@ -45,6 +45,7 @@ output + **Returns:** output is [PlanResourcesConditionalResponse](./core.planresourcesconditionalresponse.md) diff --git a/docs/core.planresourcesresponseisunconditional.md b/docs/core.planresourcesresponseisunconditional.md index 07a6d9d3..fa3c31ee 100644 --- a/docs/core.planresourcesresponseisunconditional.md +++ b/docs/core.planresourcesresponseisunconditional.md @@ -45,6 +45,7 @@ output + **Returns:** output is [PlanResourcesUnconditionalResponse](./core.planresourcesunconditionalresponse.md) diff --git a/docs/core.policyisderivedroles.md b/docs/core.policyisderivedroles.md index 747cc9aa..8f1e0841 100644 --- a/docs/core.policyisderivedroles.md +++ b/docs/core.policyisderivedroles.md @@ -45,6 +45,7 @@ policy + **Returns:** policy is [DerivedRoles](./core.derivedroles.md) diff --git a/docs/core.policyisexportconstants.md b/docs/core.policyisexportconstants.md index 178fa4fb..e3674398 100644 --- a/docs/core.policyisexportconstants.md +++ b/docs/core.policyisexportconstants.md @@ -45,6 +45,7 @@ policy + **Returns:** policy is [ExportConstants](./core.exportconstants.md) diff --git a/docs/core.policyisexportvariables.md b/docs/core.policyisexportvariables.md index f370b7f8..37ee8d4a 100644 --- a/docs/core.policyisexportvariables.md +++ b/docs/core.policyisexportvariables.md @@ -45,6 +45,7 @@ policy + **Returns:** policy is [ExportVariables](./core.exportvariables.md) diff --git a/docs/core.policyisprincipalpolicy.md b/docs/core.policyisprincipalpolicy.md index 477ff05d..b7a07f31 100644 --- a/docs/core.policyisprincipalpolicy.md +++ b/docs/core.policyisprincipalpolicy.md @@ -45,6 +45,7 @@ policy + **Returns:** policy is [PrincipalPolicy](./core.principalpolicy.md) diff --git a/docs/core.policyisresourcepolicy.md b/docs/core.policyisresourcepolicy.md index dae20601..1b448f81 100644 --- a/docs/core.policyisresourcepolicy.md +++ b/docs/core.policyisresourcepolicy.md @@ -45,6 +45,7 @@ policy + **Returns:** policy is [ResourcePolicy](./core.resourcepolicy.md) diff --git a/docs/core.policyisrolepolicy.md b/docs/core.policyisrolepolicy.md index 456101ec..94660cea 100644 --- a/docs/core.policyisrolepolicy.md +++ b/docs/core.policyisrolepolicy.md @@ -47,6 +47,7 @@ policy + **Returns:** policy is [RolePolicy](./core.rolepolicy.md) diff --git a/docs/core.schemadefinition.toobject.md b/docs/core.schemadefinition.toobject.md index 2e18c410..7e028052 100644 --- a/docs/core.schemadefinition.toobject.md +++ b/docs/core.schemadefinition.toobject.md @@ -11,6 +11,7 @@ The parsed schema definition. ```typescript toObject(): Record; ``` + **Returns:** Record<string, unknown> diff --git a/docs/core.schemadefinition.tostring.md b/docs/core.schemadefinition.tostring.md index 53eb49e9..12a07b6e 100644 --- a/docs/core.schemadefinition.tostring.md +++ b/docs/core.schemadefinition.tostring.md @@ -11,6 +11,7 @@ The JSON-serialized schema definition. ```typescript toString(): string; ``` + **Returns:** string diff --git a/docs/embedded.autoupdatingloader.activate.md b/docs/embedded.autoupdatingloader.activate.md index e4b4b1a7..bb13c363 100644 --- a/docs/embedded.autoupdatingloader.activate.md +++ b/docs/embedded.autoupdatingloader.activate.md @@ -11,6 +11,7 @@ Promote the [pending](./embedded.autoupdatingloader.pending.md) embedded policy ```typescript activate(): void; ``` + **Returns:** void diff --git a/docs/embedded.autoupdatingloader.stop.md b/docs/embedded.autoupdatingloader.stop.md index 224e6323..7bd57ee5 100644 --- a/docs/embedded.autoupdatingloader.stop.md +++ b/docs/embedded.autoupdatingloader.stop.md @@ -11,6 +11,7 @@ Stops polling for new embedded policy decision point bundles, and aborts any in- ```typescript stop(): void; ``` + **Returns:** void diff --git a/docs/embedded.loader.active.md b/docs/embedded.loader.active.md index e7d8c087..79c0db4c 100644 --- a/docs/embedded.loader.active.md +++ b/docs/embedded.loader.active.md @@ -11,6 +11,7 @@ Resolves to the metadata of the loaded bundle, or rejects with the error that wa ```typescript active(): Promise; ``` + **Returns:** Promise<[BundleMetadata](./embedded.bundlemetadata.md)> diff --git a/docs/files.parsepolicy.md b/docs/files.parsepolicy.md index ef3b5da3..53631896 100644 --- a/docs/files.parsepolicy.md +++ b/docs/files.parsepolicy.md @@ -47,6 +47,7 @@ the YAML- or JSON-encoded policy definition. + **Returns:** [Policy](./core.policy.md) diff --git a/docs/files.readdirectory.md b/docs/files.readdirectory.md index e27d5261..a8287c31 100644 --- a/docs/files.readdirectory.md +++ b/docs/files.readdirectory.md @@ -47,6 +47,7 @@ the path to the directory. + **Returns:** Promise<[DirectoryContents](./files.directorycontents.md)> diff --git a/docs/files.readpolicy.md b/docs/files.readpolicy.md index f8af3ac1..7e35b866 100644 --- a/docs/files.readpolicy.md +++ b/docs/files.readpolicy.md @@ -47,6 +47,7 @@ the path to the policy file. + **Returns:** Promise<[Policy](./core.policy.md)> diff --git a/docs/files.readschema.md b/docs/files.readschema.md index dee0c360..e32b665b 100644 --- a/docs/files.readschema.md +++ b/docs/files.readschema.md @@ -63,6 +63,7 @@ _(Optional)_ additional settings. + **Returns:** Promise<[Schema](./files.schema.md)> diff --git a/docs/grpc.grpc.close.md b/docs/grpc.grpc.close.md index c014acac..1bf35a03 100644 --- a/docs/grpc.grpc.close.md +++ b/docs/grpc.grpc.close.md @@ -11,6 +11,7 @@ Disconnect from the Cerbos policy decision point server and clean up resources. ```typescript close(): void; ``` + **Returns:** void diff --git a/docs/opentelemetry.cerbosinstrumentation.disable.md b/docs/opentelemetry.cerbosinstrumentation.disable.md index 308dde05..07dbc6a6 100644 --- a/docs/opentelemetry.cerbosinstrumentation.disable.md +++ b/docs/opentelemetry.cerbosinstrumentation.disable.md @@ -11,6 +11,7 @@ Disables the instrumentation. ```typescript disable(): void; ``` + **Returns:** void diff --git a/docs/opentelemetry.cerbosinstrumentation.enable.md b/docs/opentelemetry.cerbosinstrumentation.enable.md index 1e8f481f..f9938318 100644 --- a/docs/opentelemetry.cerbosinstrumentation.enable.md +++ b/docs/opentelemetry.cerbosinstrumentation.enable.md @@ -11,6 +11,7 @@ Enables the instrumentation. ```typescript enable(): void; ``` + **Returns:** void diff --git a/docs/opentelemetry.cerbosinstrumentation.getconfig.md b/docs/opentelemetry.cerbosinstrumentation.getconfig.md index f08ccbf6..cacd7e4d 100644 --- a/docs/opentelemetry.cerbosinstrumentation.getconfig.md +++ b/docs/opentelemetry.cerbosinstrumentation.getconfig.md @@ -11,6 +11,7 @@ Gets the instrumentation configuration. ```typescript getConfig(): CerbosInstrumentationConfig; ``` + **Returns:** [CerbosInstrumentationConfig](./opentelemetry.cerbosinstrumentationconfig.md) diff --git a/docs/opentelemetry.cerbosinstrumentation.setconfig.md b/docs/opentelemetry.cerbosinstrumentation.setconfig.md index 71c27824..f1463572 100644 --- a/docs/opentelemetry.cerbosinstrumentation.setconfig.md +++ b/docs/opentelemetry.cerbosinstrumentation.setconfig.md @@ -45,6 +45,7 @@ config + **Returns:** void diff --git a/docs/opentelemetry.cerbosinstrumentation.setmeterprovider.md b/docs/opentelemetry.cerbosinstrumentation.setmeterprovider.md index b8afe622..5d66172d 100644 --- a/docs/opentelemetry.cerbosinstrumentation.setmeterprovider.md +++ b/docs/opentelemetry.cerbosinstrumentation.setmeterprovider.md @@ -45,6 +45,7 @@ MeterProvider + **Returns:** void diff --git a/docs/opentelemetry.cerbosinstrumentation.settracerprovider.md b/docs/opentelemetry.cerbosinstrumentation.settracerprovider.md index e0f2be30..50f84871 100644 --- a/docs/opentelemetry.cerbosinstrumentation.settracerprovider.md +++ b/docs/opentelemetry.cerbosinstrumentation.settracerprovider.md @@ -45,6 +45,7 @@ TracerProvider + **Returns:** void diff --git a/docs/react.cerbosprovider.md b/docs/react.cerbosprovider.md index 8d34b0ea..82fdaa21 100644 --- a/docs/react.cerbosprovider.md +++ b/docs/react.cerbosprovider.md @@ -45,6 +45,7 @@ Description + **Returns:** ReactElement diff --git a/docs/react.usecerbos.md b/docs/react.usecerbos.md index e4d44673..2bdce7a4 100644 --- a/docs/react.usecerbos.md +++ b/docs/react.usecerbos.md @@ -11,6 +11,7 @@ A hook to access the Cerbos client passed down by the [CerbosProvider()](./react ```typescript export declare function useCerbos(): ClientWithPrincipal; ``` + **Returns:** [ClientWithPrincipal](./core.clientwithprincipal.md) diff --git a/docs/react.usecheckresource.md b/docs/react.usecheckresource.md index 0bc63d60..acc3c904 100644 --- a/docs/react.usecheckresource.md +++ b/docs/react.usecheckresource.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** [AsyncResult](./react.asyncresult.md)<[CheckResourcesResult](./core.checkresourcesresult.md)> diff --git a/docs/react.usecheckresources.md b/docs/react.usecheckresources.md index f6a983ad..3abd1fd8 100644 --- a/docs/react.usecheckresources.md +++ b/docs/react.usecheckresources.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** [AsyncResult](./react.asyncresult.md)<[CheckResourcesResponse](./core.checkresourcesresponse.md)> diff --git a/docs/react.useisallowed.md b/docs/react.useisallowed.md index a20dbf83..86e83929 100644 --- a/docs/react.useisallowed.md +++ b/docs/react.useisallowed.md @@ -61,6 +61,7 @@ _(Optional)_ + **Returns:** [AsyncResult](./react.asyncresult.md)<boolean> diff --git a/package.json b/package.json index e2f6415d..b67f4902 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "build:watch": "tsc --build --watch", "clean": "rm -rf api packages/*/lib private/*/tsconfig.tsbuildinfo", "docs": "pnpm run build && pnpm run api:extract && pnpm run api:fixup && pnpm run docs:generate && pnpm run docs:fixup", - "docs:fixup": "scripts/sed-all docs 's/\\r$//'", + "docs:fixup": "scripts/sed-all docs -e 's/\\r$//' -e 's/^\\*\\*Returns:\\*\\*/\\n&/'", "docs:generate": "api-documenter markdown --input-folder api --output-folder docs", "generate": "pnpm run generate:clean && pnpm run all:parallel 'pnpm:generate:*(!clean|format)' && pnpm run generate:format", "generate:buf:core": "buf generate --template=packages/core/buf.gen.yaml",