Module platformdirs.platforms.macos

macOS

Functions

M.PlatformDirs:new (platformdirs)
M.PlatformDirs.get_home ()

user/site directories

M.PlatformDirs:user_data_dir () /Users/$USER/Library/Application Support/$app/$version
M.PlatformDirs:site_data_dir () /Library/Application Support/$app/$version
M.PlatformDirs:user_cache_dir () /Users/$USER/Library/Caches/$app/$version
M.PlatformDirs:site_cache_dir () /Library/Caches/$app/$version
M.PlatformDirs:user_log_dir () /Users/$USER/Library/Logs/$app/$version
M.PlatformDirs:user_runtime_dir () /Users/$USER/Library/TemporaryItems/$app/$version

user directories

M.PlatformDirs:user_documents_dir () /Users/$USER/Documents
M.PlatformDirs:user_downloads_dir () /Users/$USER/Downloads
M.PlatformDirs:user_pictures_dir () /Users/$USER/Pictures
M.PlatformDirs:user_videos_dir () /Users/$USER/Movies
M.PlatformDirs:user_music_dir () /Users/$USER/Music
M.PlatformDirs:user_desktop_dir () /Users/$USER/Desktop


Functions

M.PlatformDirs:new (platformdirs)

Parameters:

  • platformdirs table?

Returns:

    table platformdirs
M.PlatformDirs.get_home ()

Returns:

    string

user/site directories

M.PlatformDirs:user_data_dir ()
/Users/$USER/Library/Application Support/$app/$version

Returns:

    string
M.PlatformDirs:site_data_dir ()
/Library/Application Support/$app/$version

Returns:

    string
M.PlatformDirs:user_cache_dir ()
/Users/$USER/Library/Caches/$app/$version

Returns:

    string
M.PlatformDirs:site_cache_dir ()
/Library/Caches/$app/$version

Returns:

    string
M.PlatformDirs:user_log_dir ()
/Users/$USER/Library/Logs/$app/$version

Returns:

    string
M.PlatformDirs:user_runtime_dir ()
/Users/$USER/Library/TemporaryItems/$app/$version

Returns:

    string

user directories

M.PlatformDirs:user_documents_dir ()
/Users/$USER/Documents

Returns:

    string
M.PlatformDirs:user_downloads_dir ()
/Users/$USER/Downloads

Returns:

    string
M.PlatformDirs:user_pictures_dir ()
/Users/$USER/Pictures

Returns:

    string
M.PlatformDirs:user_videos_dir ()
/Users/$USER/Movies

Returns:

    string
M.PlatformDirs:user_music_dir ()
/Users/$USER/Music

Returns:

    string
M.PlatformDirs:user_desktop_dir ()
/Users/$USER/Desktop

Returns:

    string
generated by LDoc 1.5.0 Last updated 2025-12-25 12:32:44