Class StringCollection

Contains a collection of interned strings.

Implements

IStringCollection

Index

Constructors

Methods

add addMultiple beginPersist getById getCount

Constructors

constructor

new StringCollection(): StringCollection
Returns StringCollection

Methods

add

add(shared: string): number
Add a string to the collection.
Parameters
- shared: string
  A string
Returns number
Remarks
Resources are not removed from the the collection. They are autoGCed when there are no references.

Implementation of IStringCollection.add

addMultiple

addMultiple(shared: string[], conflateDuplicates?: boolean): void
Add multiple string to the collection.
Parameters
- shared: string[]
  An array of strings
- conflateDuplicates: boolean = false
  If the same string is in the list it will be conflated. Default value false.
Returns void
Remarks
There are instances where Excel may have duplicate strings so by default this is false.

Implementation of IStringCollection.addMultiple

beginPersist

beginPersist(): ICollection.IPersistScope<string>
Used for saving items. Returns a handler that will allow for writing JSON records only save the items that were accessed within the persist scope.

Returns ICollection.IPersistScope<string>
Implementation of IStringCollection.beginPersist

getById

getById(id: number): string
Returns the string for the given id.
Parameters
- id: number
  The id
Returns string
Implementation of IStringCollection.getById

getCount

getCount(): number
Returns the total items available.

Returns number
Remarks
Useful as a quick escape for search.

Implementation of IStringCollection.getCount