doc comments to explain public vs private validators

XYOracleNetwork · Sep 4, 2024 · 4a5cca5 · 4a5cca5
1 parent db39b84
commit 4a5cca5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/packages/payload/packages/xns/plugins/record/src/helpers/validation/private/validators.ts b/packages/payload/packages/xns/plugins/record/src/helpers/validation/private/validators.ts
@@ -1,3 +1,7 @@
+/**
+ * NOTE: These validators are private because they rely on private data that cannot be shared with clients.
+ */
+
 import type { PayloadValidationFunction, WithSources } from '@xyo-network/payload-model'
 
 import type { DomainRegistration } from '../../../DomainRegistration/index.ts'

diff --git a/...payload/packages/xns/plugins/record/src/helpers/validation/public/spec/validators.spec.ts b/...payload/packages/xns/plugins/record/src/helpers/validation/public/spec/validators.spec.ts
@@ -1,3 +1,8 @@
+/**
+ * NOTE: These validators are public because they can be validated by clients
+ * and require no special access to private data.
+ */
+
 import type { WithSources } from '@xyo-network/payload-model'
 
 import type { DomainRegistration } from '../../../../DomainRegistration/index.ts'