Node os.userInfo function | API Reference | Bun
BuildDocsReferenceGuidesBlogDiscord/
node:os/
userInfoFuserInfo
Search the reference...
/
BuildDocsReferenceGuidesBlogDiscord/
node:os/
userInfoFuserInfo
function
os.userInfofunction
userInfo(options?:
UserInfoOptionsWithStringEncoding):
UserInfostring>;
Returns information about the currently effective user. On POSIX platforms, this is typically a subset of the password file. The returned object includes the username, uid, gid, shell, and homedir. On Windows, the uid and gid fields are -1, and shell is null.
The value of homedir returned by os.userInfo() is provided by the operating system. This differs from the result of os.homedir(), which queries environment variables for the home directory before falling back to the operating system response.
Throws a SystemError if a user has no username or homedir.
function
userInfo(options:
UserInfoOptionsWithBufferEncoding):
UserInfoNonSharedBuffer>;
Returns information about the currently effective user. On POSIX platforms, this is typically a subset of the password file. The returned object includes the username, uid, gid, shell, and homedir. On Windows, the uid and gid fields are -1, and shell is null.
The value of homedir returned by os.userInfo() is provided by the operating system. This differs from the result of os.homedir(), which queries environment variables for the home directory before falling back to the operating system response.
Throws a SystemError if a user has no username or homedir.
function
userInfo(options:
UserInfoOptions):
UserInfostring | NonSharedBuffer>;
Returns information about the currently effective user. On POSIX platforms, this is typically a subset of the password file. The returned object includes the username, uid, gid, shell, and homedir. On Windows, the uid and gid fields are -1, and shell is null.
The value of homedir returned by os.userInfo() is provided by the operating system. This differs from the result of os.homedir(), which queries environment variables for the home directory before falling back to the operating system response.
Throws a SystemError if a user has no username or homedir.
Referenced typesinterface
UserInfoOptionsWithStringEncodingencoding?: BufferEncodinginterface
UserInfoT>
gid: number
homedir: T
shell: null | T
uid: number
username: Tinterface
UserInfoOptionsWithBufferEncodingencoding: 'buffer'interface
UserInfoOptionsencoding?: BufferEncoding | 'buffer'
Resources
ReferenceDocsGuidesDiscordMerch StoreGitHubBlog Toolkit
RuntimePackage managerTest runnerBundlerPackage runnerProject
Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicenseBaked with ❤️ in San Francisco
We're hiring →