Class Album

The Switch.Album class allows for interacting with the Switch's photo gallery, providing access to the screenshots / video recordings that the user has saved.

It is a Set subclass, which contains entries of Switch.AlbumFile instances.

Example

import { CapsAlbumStorage } from '@nx.js/constants';

const album = new Switch.Album(CapsAlbumStorage.Sd);
for (const file of album) {
  console.log(file);
}

Hierarchy

Constructors

constructor

Properties

[toStringTag] size storage [species]

Methods

[iterator] add clear delete entries forEach has keys values

Constructors

constructor

  • new Album(storage): Album

  • Parameters

    • storage: number

    Returns Album

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

Returns

the number of (unique) elements in Set.

Readonly storage

storage: number

Static Readonly [species]

[species]: SetConstructor

Methods

[iterator]

  • [iterator](): IterableIterator<AlbumFile>

  • Returns IterableIterator<AlbumFile>

add

  • add(value): this

  • Appends a new element with a specified value to the end of the Set.

    Parameters

    Returns this

clear

  • clear(): void

  • Returns void

delete

  • delete(value): boolean

  • Removes a specified value from the Set.

    Parameters

    Returns boolean

    Returns true if an element in the Set existed and has been removed, or false if the element does not exist.

entries

forEach

  • forEach(callbackfn, thisArg?): void

  • Executes a provided function once per each value in the Set object, in insertion order.

    Parameters

    • callbackfn: ((value, value2, set) => void)
    • Optional thisArg: any

    Returns void

has

  • has(value): boolean

  • Parameters

    Returns boolean

    a boolean indicating whether an element with the specified value exists in the Set or not.

keys

  • keys(): IterableIterator<AlbumFile>

  • Returns IterableIterator<AlbumFile>

values

  • values(): IterableIterator<AlbumFile>

  • Returns IterableIterator<AlbumFile>

Settings

Member Visibility

Theme

On This Page

constructor[toStringTag]sizestorage[species][iterator]addcleardeleteentriesforEachhaskeysvalues