Private
Optional
_rxjsPrivate
Readonly
eventPrivate
Readonly
onPrivate
Readonly
rateStatic
ErrorsURL of the peer to add
Private
authenticateAuthenticates user after creation
Optional
pair: null | ISEAPairPrivate
buildBuilds the full path for frozen data
Optional
options: { namespace?: string; path?: string }Private
buildChanges the username for the currently authenticated user
New username to set
Promise resolving to the operation result
Private
checkClear session
Creates a frozen space entry for immutable data
Data to freeze
Optional
options: {Optional configuration
Promise resolving to the frozen data hash
Private
createPrivate
createPrivate
createCreates a new user in Gun with pair-based authentication (for Web3/plugins)
Private
decryptDecrypts session data from storage
Derive cryptographic keys from password and optional extras Supports multiple key derivation algorithms: P-256, secp256k1 (Bitcoin), secp256k1 (Ethereum)
Password or seed for key derivation
Optional
extra: string | string[]Additional entropy (string or array of strings)
Optional
options: DeriveOptionsDerivation options to specify which key types to generate
Promise resolving to derived keys object
Derive all supported key types
Password for key derivation
Optional
extra: string | string[]Additional entropy
Promise resolving to all key types
Derive Bitcoin secp256k1 keys with P2PKH address
Password for key derivation
Optional
extra: string | string[]Additional entropy
Promise resolving to Bitcoin keys and address
Derive Ethereum secp256k1 keys with Keccak256 address
Password for key derivation
Optional
extra: string | string[]Additional entropy
Promise resolving to Ethereum keys and address
Derive P-256 keys (default Gun.SEA behavior)
Password for key derivation
Optional
extra: string | string[]Additional entropy
Promise resolving to P-256 keys
Emits an event
Event name
Optional
data: anyEvent data
Private
emitPrivate
Emits a Gun data event
Optional
data: anyOptional
error: stringPrivate
emitPrivate
Emits a Gun peer event
Private
encryptEncrypts session data before storage
Recovers password hint using security question answers
Username
Array of answers to security questions
Promise resolving with the password hint
Private
generateGenerates hash for frozen data
Gets a node at the specified path
Path to the node
Gun node
Gets the list of all configured peers (connected and disconnected)
Array of peer URLs
Get app scope
Gets the list of currently connected peers
Array of peer URLs
Gets the current user
Current user object or null
Gets data at the specified path (one-time read)
Path to get the data from
Promise resolving to the data
Retrieves data from frozen space
Hash of the frozen data
Optional namespace
Optional
path: stringOptional custom path
Promise resolving to the frozen data
Gets the Gun instance
Gun instance
Get password hint
Gets detailed information about all peers
Object with peer information
Gets the current user instance
User instance
Gets user data from the specified path
Path to get the data from (supports nested paths like "test/data/marco")
Promise that resolves with the data
Get username for the current user
Get user public key
Initialize the GunInstance asynchronously This method should be called after construction to perform async operations
Check if user is authenticated
Checks if a user is currently logged in
True if logged in
Leave user session
Load session from storage
Optional
pair: null | ISEAPairPrivate
lookupPrivate
lookupPrivate
lookupPrivate
lookupStrategy 1: Frozen space scan for immutable data
Private
navigateHelper method to navigate to a nested path by splitting and chaining .get() calls
Starting Gun node
Path string (e.g., "test/data/marco")
Gun node at the specified path
Private
normalizePrivate
notifyRemoves an event listener
Event name
Event listener function
Adds an event listener
Event name
Event listener function
Registers an authentication callback
Function to call on auth events
Function to unsubscribe the callback
Adds a one-time event listener
Event name
Event listener function
Private
performPerforms authentication with Gun
Optional
pair: null | ISEAPairPrivate
preparePrivate
processProcesses lookup result to get complete user data
Puts data at the specified path
Path to store data
Data to store
Promise resolving to operation result
Saves user data at the specified path
Path to save the data (supports nested paths like "test/data/marco")
Data to save
Promise that resolves when the data is saved
Recall user session
Reconnects to a specific peer
URL of the peer to reconnect
Removes data at the specified path
Path to remove
Promise resolving to operation result
Removes a peer from the network
URL of the peer to remove
Clears all peers and optionally adds new ones
Optional
newPeers: string[]Optional array of new peers to add
Reset rate limit
Private
resetResets rate limiting for successful authentication
Attempts to restore user session from local storage
Promise resolving to session restoration result
Private
runPrivate
sanitizeSanitizes username to prevent path construction issues
Raw username
Sanitized username
Private
saveSave session to storage
Sets data at the specified path
Path to store data
Data to store
Promise resolving to operation result
Set password hint
Sets up security questions and password hint
Username
Current password
Password hint
Array of security questions
Array of answers to security questions
Promise resolving with the operation result
Set user data
Set username for the current user
Signs up a new user using direct Gun authentication
Username
Password
Optional
pair: null | ISEAPairOptional SEA pair for Web3 login
Promise resolving to signup result
Private
storePrivate
subscribeDebug method: Tests Gun connectivity and returns status information This is useful for debugging connection issues
Updates the user's alias (username) in Gun and saves the updated credentials
New alias/username to set
Promise resolving to update result
Private
validateValidates password strength according to security requirements
Private
validateVerifies if data matches a frozen space entry
Data to verify
Expected hash
Optional namespace
Optional
path: stringOptional custom path
Promise resolving to verification result
Adds a new peer to the network