western-signsv1.13.5
GitHub
    Preparing search index...

    Function getPlanet

    • Get a single planet with its translated properties for a specified language.

      Parameters

      • planetName: Planets

        The key corresponding to the desired planet.

      • Optionallanguage: Language = 'en'

        The language code to use for translations. Defaults to 'en'.

      Returns Planet | null

      An object with translated values based on the specified language, or null if the planet key is invalid.

      import { getPlanet, PLANETS } from 'western-signs';

      // Retrieve information about Mars in English
      const mars = getPlanet(PLANETS.MARS);
      console.log(mars);
      // Output:
      // {
      //   name: 'Mars',
      //   glyph: '♂',
      //   type: 'Personal'
      // }
    Settings
    Member Visibility