Class SnippetService

Service for managing snippets and interacting with data access.

Constructors

constructor

new SnippetService(_dataAccess: DataAccess): SnippetService
Creates an instance of the SnippetService.
Parameters
- _dataAccess: DataAccess
  The data access object used for loading and saving snippets.
Returns SnippetService
- Defined in service/snippetService.ts:18

Methods

addExistingSnippet

addExistingSnippet(newSnippet: Snippet): void
Adds an existing snippet to the appropriate parent in the snippet collection. If the parent ID is root, the snippet is added to the root's children. Otherwise, the snippet is added to the parent identified by the parentId.
Parameters
- newSnippet: Snippet
  The snippet to add.
Returns void
- Defined in service/snippetService.ts:242

addSnippet

addSnippet(newSnippet: Snippet): void
Adds a new snippet to the collection and updates the last used ID.
Parameters
- newSnippet: Snippet
  The snippet to add.
Returns void
- Defined in service/snippetService.ts:231

compact

compact(): string
Converts the root snippet object to a JSON string representation.

Returns string
A JSON string of the root snippet.
- Defined in service/snippetService.ts:220

exportSnippets

exportSnippets(destinationPath: string, parentId: number): void
Exports snippets from a specific parent to a destination file path.
Parameters
- destinationPath: string
  The path where snippets should be exported.
- parentId: number
  The parent ID to start exporting from.
Returns void
- Defined in service/snippetService.ts:375

fixLastId

fixLastId(): void
Ensures that the lastId property in the root snippet is updated to the maximum ID found in all snippets.

Returns void
- Defined in service/snippetService.ts:159

getAllSnippets

getAllSnippets(): Snippet[]
Retrieves all snippets (flattened) from the root snippet's children.

Returns Snippet[]
An array of all snippets.
- Defined in service/snippetService.ts:179

getAllSnippetsAndFolders

getAllSnippetsAndFolders(): Snippet[]
Retrieves all snippets and folders (flattened) from the root snippet's children.

Returns Snippet[]
An array of all snippets and folders.
- Defined in service/snippetService.ts:191

getParent

getParent(parentId: undefined | number): undefined | Snippet
Retrieves the parent snippet by its ID.
Parameters
- parentId: undefined | number
  The ID of the parent snippet.
Returns undefined | Snippet
The parent snippet, or undefined if not found.
- Defined in service/snippetService.ts:212

getRootChildren

getRootChildren(): Snippet[]
Retrieves the children of the root snippet.

Returns Snippet[]
An array of snippet children.
- Defined in service/snippetService.ts:171

importSnippets

importSnippets(destinationPath: string): void
Imports snippets from a specified file path and replaces the current snippets. A backup of the current snippets is saved before the import.
Parameters
- destinationPath: string
  The path from which to import the snippets.
Returns void
- Defined in service/snippetService.ts:388

incrementLastId

incrementLastId(): number
Increments and returns the next available ID for a snippet.

Returns number
The next available ID.
- Defined in service/snippetService.ts:203

loadSnippets

loadSnippets(): Snippet
Loads the snippets from the data source.

Returns Snippet
The root snippet object.
- Defined in service/snippetService.ts:145

moveSnippet

moveSnippet(snippet: Snippet, offset: number): void
Moves a snippet by the specified offset in the list of its siblings.
Parameters
- snippet: Snippet
  The snippet to move.
- offset: number
  The offset to move the snippet by (positive or negative).
Returns void
- Defined in service/snippetService.ts:338

overrideSnippetId

overrideSnippetId(snippet: Snippet): void
Overrides the snippet's ID with a new ID and updates the snippet. The last used ID is also updated after assigning the new ID to the snippet.
Parameters
- snippet: Snippet
  The snippet to update with a new ID.
Returns void
- Defined in service/snippetService.ts:292

refresh

refresh(): void
Refreshes the root snippet by reloading it from the data source.

Returns void
- Defined in service/snippetService.ts:137

removeSnippet

removeSnippet(snippet: Snippet): void
Removes a snippet from the collection and deletes its associated Gist.
Parameters
- snippet: Snippet
  The snippet to remove.
Returns void
- Defined in service/snippetService.ts:303

removeSnippetLocally

removeSnippetLocally(snippet: Snippet): void
Removes a snippet from the collection locally without deleting the associated Gist.
Parameters
- snippet: Snippet
  The snippet to remove.
Returns void
- Defined in service/snippetService.ts:320

saveSnippets

saveSnippets(): void
Saves the current root snippet to the data source.

Returns void
- Defined in service/snippetService.ts:152

sortAllSnippets

sortAllSnippets(): void
Sorts all snippets and their children.

Returns void
- Defined in service/snippetService.ts:363

sortSnippets

sortSnippets(snippet: Snippet): void
Sorts the children of a snippet if it is a folder.
Parameters
- snippet: Snippet
  The snippet to sort.
Returns void
- Defined in service/snippetService.ts:354

updateSnippet

updateSnippet(snippet: Snippet): Promise<void>
Updates an existing snippet in the collection by its ID and updates the associated Gist. If the snippet is a folder, the content is not updated; otherwise, the content is updated.
Parameters
- snippet: Snippet
  The snippet to update.
Returns Promise<void>
- Defined in service/snippetService.ts:253

`Static`findParent

findParent(parentId: number, currentElt: Snippet): undefined | Snippet
Recursively searches for the parent snippet by its ID in the given snippet tree.
Parameters
- parentId: number
  The ID of the parent snippet to find.
- currentElt: Snippet
  The current snippet being examined.
Returns undefined | Snippet
The parent snippet if found, otherwise undefined.
- Defined in service/snippetService.ts:30

`Static`flattenAndKeepFolders

flattenAndKeepFolders(arr: any, result?: any[]): any[]
Parameters
- arr: any
- result: any[] = []
Returns any[]
- Defined in service/snippetService.ts:75