Skip to content

Commit a246054

Browse files
achingbrainrvagg
authored andcommitted
docs: fix typos in jsdoc comments
Fixes typos in comments used for generated documentation
1 parent 2ee6012 commit a246054

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

Diff for: src/block/interface.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { CID } from '../cid.js'
1010
* a `Data` type parameter indicating the type of encoded data.
1111
*
1212
* For example, a `ByteView<{ hello: "world" }>` is a `Uint8Array` containing a
13-
* binary representation of a `{hello: "world"}.
13+
* binary representation of a `{hello: "world"}`.
1414
*/
1515
export interface ByteView<Data> extends Uint8Array, Phantom<Data> {}
1616

@@ -22,16 +22,16 @@ declare const Marker: unique symbol
2222
*
2323
* Capturing unused type parameters allows us to define "nominal types," which
2424
* TypeScript does not natively support. Nominal types in turn allow us to capture
25-
* semantics not represented in the actual type structure, without requring us to define
25+
* semantics not represented in the actual type structure, without requiring us to define
2626
* new classes or pay additional runtime costs.
2727
*
2828
* For a concrete example, see {@link ByteView}, which extends the `Uint8Array` type to capture
2929
* type information about the structure of the data encoded into the array.
3030
*/
3131
export interface Phantom<T> {
32-
// This field can not be represented because field name is nonexistent
32+
// This field can not be represented because field name is non-existent
3333
// unique symbol. But given that field is optional any object will valid
34-
// type contstraint.
34+
// type constraint.
3535
[Marker]?: T
3636
}
3737

Diff for: src/cid.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ export class CID {
226226
* a `CID` otherwise returns `null`. If `value` is instanceof `CID`
227227
* it will return value back. If `value` is not instance of this CID
228228
* class, but is compatible CID it will return new instance of this
229-
* `CID` class. Otherwise returs null.
229+
* `CID` class. Otherwise returns null.
230230
*
231231
* This allows two different incompatible versions of CID library to
232232
* co-exist and interop as long as binary interface is compatible.

Diff for: src/hashes/digest.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export const equals = (a, b) => {
6666

6767
/**
6868
* Represents a multihash digest which carries information about the
69-
* hashing alogrithm and an actual hash digest.
69+
* hashing algorithm and an actual hash digest.
7070
*
7171
* @template {number} Code
7272
* @template {number} Size

0 commit comments

Comments
 (0)