Class OId

Represents a unique ID of any object.

record

Hierarchy

OId

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new OId(): OId

Returns OId

Properties

Static name

name: string

Methods

compare

compare(b: OId): number

- Defined in Ggit-1.0.d.ts:6949
Compare two #GgitOId structures.

Parameters
- b: OId
  
  second #GgitOId.
Returns number

copy

copy(): OId

- Defined in Ggit-1.0.d.ts:6953
Copies oid into a newly allocated #GgitOId.

Returns OId

equal

equal(b: OId): boolean

- Defined in Ggit-1.0.d.ts:6958
Compares two #GgitOId for equality.

Parameters
- b: OId
  
  a #GgitOId.
Returns boolean

free

free(): void

- Defined in Ggit-1.0.d.ts:6962
Frees oid.

Returns void

hasPrefix

hasPrefix(prefix: string): boolean

- Defined in Ggit-1.0.d.ts:6968
Check whether the object id has a given prefix. Note that the prefix is specified in hexadecimal ASCII.

Parameters
- prefix: string
  
  a prefix.
Returns boolean

hash

hash(): number

- Defined in Ggit-1.0.d.ts:6972
Computes a hash value for a git object identifier.

Returns number

isZero

isZero(): boolean

- Defined in Ggit-1.0.d.ts:6976
Get whether the oid contains only zeros.

Returns boolean

toString

toString(): string

- Defined in Ggit-1.0.d.ts:6980
Converts oid into a readable string.

Returns string

Static newFromRaw

newFromRaw(raw: Uint8Array): OId

- Defined in Ggit-1.0.d.ts:7000
Creates a new #GgitOId from a raw oid.

Parameters
- raw: Uint8Array
  
  the raw input bytes to be copied.
Returns OId

Static newFromString

newFromString(str: string): OId

- Defined in Ggit-1.0.d.ts:7006
Parses a hex formatted object id into a #GgitOId.

Parameters
- str: string
  
  input hex string; must be pointing at the start of the hex sequence and have at least the number of bytes needed for an oid encoded in hex (40 bytes).
Returns OId