-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
19 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# avro-crc64 API | ||
|
||
## fingerprint64AvroSchema(schemaString: string): Promise<Uint8Array> | ||
fingerprint64AvroSchema returns a promise which resolves to a Rabin 64-bit crc fingerprint as 8 byte [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array). | ||
|
||
### Parameters | ||
- schemaString<string>: [Apache AVRO](https://avro.apache.org/docs/current/) schema in string representation | ||
|
||
### Returns | ||
- Promise<Uint8Array>: 64-bit fingerprint | ||
|
||
### Errors | ||
The returned promise will reject with: | ||
- AvroSchemaStringSyntaxError<Error>: In case parsing of schemaString fails with a SytaxError Exception | ||
- InvalidAvroSchemaError<Error>: In case a [AVSC](https://github.com/mtth/avsc) AVRO Type could not be instantiated with parsed schemaString object. |
This file was deleted.
Oops, something went wrong.