LseqPosId | @m-ld/m-ld - v0.9.2-edge.3

Hierarchy

LseqPosId

Index

Constructors

constructor

Properties

ids
lseq

Methods

Constructors

constructor

new LseqPosId(ids: { pos: number; site: string | null }[], lseq: LseqDef, id?: undefined | string): LseqPosId

Parameters
- ids: { pos: number; site: string | null }[]
  
  the parsed position Id
- lseq: LseqDef
  
  the LSEQ definition to use
- Optional id: undefined | string
  
  the position Id as a string, if available
Returns LseqPosId

Properties

Readonly ids

ids: { pos: number; site: string | null }[]

the parsed position Id

Readonly lseq

the LSEQ definition to use

Methods

between

between(that: LseqPosId, site: string, count?: number): LseqPosId[]

this and that must be adjacent in the list.

Parameters
- that: LseqPosId
  
  the upper bound for the new position
- site: string
- Default value count: number = 1
Returns LseqPosId[]

equals

equals(that: LseqPosId): boolean

Parameters
- that: LseqPosId
Returns boolean

toString

toString(): string

Returns string

Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.9.2-edge.3 Source code licensed MIT. Privacy policy