Class BookmarkFactory

BookmarkFactory class that provides factory methods for creating and managing Bookmark instances.

Constructors

constructor

Properties

containerUrls instance

Methods

create get getAll remove update getInstance

Constructors

Private constructor

Properties

Private containerUrls

containerUrls: string[] = []

Static Private instance

instance: BookmarkFactory

Methods

create

  • create(payload): Promise<undefined | Bookmark>

  • Creates a new Bookmark instance with the given payload. Generates a UUID for the id, sets the url to the first configured containerUrl + id, and saves the new Bookmark instance.

    Parameters

    Returns Promise<undefined | Bookmark>

    The saved Bookmark instance .

get

  • get(url): Promise<undefined | Bookmark>

  • Retrieves a Bookmark instance by its url.

    Parameters

    • url: string

      The url of the Bookmark to retrieve.

    Returns Promise<undefined | Bookmark>

    The Bookmark instance if found, otherwise throws error.

getAll

  • getAll(): Promise<(Bookmark & SolidModel)[]>

  • Retrieves all Bookmark instances from the configured containerUrls and instancesUrls.

    Makes a request to each configured containerUrl and instancesUrl to get all Bookmark instances. Combines and flattens the results into a single array.

    Returns the array of Bookmark instances.

    Returns Promise<(Bookmark & SolidModel)[]>

remove

  • remove(url): Promise<undefined | Bookmark>

  • Removes a Bookmark instance identified by its url.

    Parameters

    • url: string

      The url of the Bookmark to remove.

    Returns Promise<undefined | Bookmark>

    A Promise resolving to the deleted Bookmark instance if successful, otherwise undefined.

update

  • update(url, payload): Promise<undefined | Bookmark>

  • Updates an existing Bookmark instance identified by its url.

    Parameters

    • url: string

      The url of the Bookmark to update.

    • payload: IBookmark

      The data to update the Bookmark with.

    Returns Promise<undefined | Bookmark>

    The updated Bookmark instance if successful, otherwise undefined.

Static getInstance

  • getInstance(args?, defaultContainerUrl?): Promise<BookmarkFactory>

  • Gets an instance of the BookmarkFactory class, which provides methods for creating and managing Bookmark instances.

    Checks if an instance already exists and returns it. If not, it creates a new instance by:

    Parameters

    • Optional args: GetInstanceArgs
    • Optional defaultContainerUrl: string

      The default container url to use if none exist.

    Returns Promise<BookmarkFactory>

    a Promise resolving to the BookmarkFactory instance.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc