service/domain/document/document
Api Code Documentation / Exports / service/domain/document/document
Table of contents
Interfaces
- DeleteDocumentResponse
- DeletedDocument
- DocumentLink
- DocumentReference
- ExternalLinkReference
- GenericDocument
- StoredDocument
- UploadedDocument
Type Aliases
Variables
- MAX_DOCUMENT_SIZE_BASE64
- MAX_DOCUMENT_SIZE_BINARY
- documentReferenceSchema
- storedDocumentSchema
- uploadedDocumentSchema
Functions
Type Aliases
DocumentOrExternalLinkReference
Ƭ DocumentOrExternalLinkReference: DocumentReference
| ExternalLinkReference
Defined in
src/service/domain/document/document.ts:53
DocumentWithAvailability
Ƭ DocumentWithAvailability: DocumentOrExternalLinkReference
& { comment?
: string
; isValidHash?
: boolean
; lastModified?
: string
}
Defined in
src/service/domain/document/document.ts:55
UploadedDocumentOrLink
Ƭ UploadedDocumentOrLink: UploadedDocument
| DocumentLink
Defined in
src/service/domain/document/document.ts:96
Variables
MAX_DOCUMENT_SIZE_BASE64
• Const
MAX_DOCUMENT_SIZE_BASE64: number
Defined in
src/service/domain/document/document.ts:10
MAX_DOCUMENT_SIZE_BINARY
• Const
MAX_DOCUMENT_SIZE_BINARY: number
Defined in
src/service/domain/document/document.ts:9
documentReferenceSchema
• Const
documentReferenceSchema: AlternativesSchema
<any
>
Defined in
src/service/domain/document/document.ts:61
storedDocumentSchema
• Const
storedDocumentSchema: ObjectSchema
<any
>
Defined in
src/service/domain/document/document.ts:23
uploadedDocumentSchema
• Const
uploadedDocumentSchema: AlternativesSchema
<any
>
Defined in
src/service/domain/document/document.ts:98
Functions
hashBase64String
▸ hashBase64String(base64String
): Promise
<string
>
Parameters
Name | Type |
---|---|
base64String | string |
Returns
Promise
<string
>
Defined in
src/service/domain/document/document.ts:157
hashDocument
▸ hashDocument(document
): Promise
<Type
<DocumentReference
>>
Parameters
Name | Type |
---|---|
document | UploadedDocument |
Returns
Promise
<Type
<DocumentReference
>>
Defined in
src/service/domain/document/document.ts:124
hashDocuments
▸ hashDocuments(documents
): Promise
<Type
<DocumentReference
[]>>
Parameters
Name | Type |
---|---|
documents | UploadedDocument [] |
Returns
Promise
<Type
<DocumentReference
[]>>
Defined in
src/service/domain/document/document.ts:136
validate
▸ validate(input
): Type
<UploadedDocument
>
Parameters
Name | Type |
---|---|
input | any |