Struct NodeApiKey 

pub struct NodeApiKey { /* private fields */ }

Safe API key wrapper.

This wrapper prevents accidental logging or printing of API keys. The key value is hidden from toString() and debug output.

const key = new NodeApiKey('sk-secret-key');
console.log(key.toString()); // "[REDACTED]"
console.log(key.exposeSecretForApiCall()); // "sk-secret-key"

Implementations

impl NodeApiKey

pub fn instance_of<V: NapiRaw>(env: Env, value: V) -> Result<bool>

impl NodeApiKey

pub fn into_reference( val: NodeApiKey, env: Env, ) -> Result<Reference<NodeApiKey>>

pub fn into_instance(self, env: Env) -> Result<ClassInstance<NodeApiKey>>

impl NodeApiKey

pub fn new(key: String) -> Self

Create a new API key from a string.

Security Note: Prefer loading keys from CredentialStore rather than hardcoding them.

pub fn to_string(&self) -> String

Returns “[REDACTED]” - safe for logging.

This method intentionally hides the key value to prevent accidental exposure in logs.

pub fn expose_secret_for_api_call(&self) -> String

Get the actual key value.

Warning: Only use this when actually sending to an API. The verbose method name is intentional to discourage casual use.

pub fn is_empty(&self) -> bool

Check if the key is empty.

pub fn length(&self) -> u32

Get the length of the key.

pub fn starts_with(&self, prefix: String) -> bool

Check if the key starts with a prefix (e.g., “sk-ant-” for Anthropic).

Trait Implementations

impl Debug for NodeApiKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromNapiMutRef for NodeApiKey

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

Safety

impl FromNapiRef for NodeApiKey

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

Safety

impl FromNapiValue for &NodeApiKey

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

impl FromNapiValue for &mut NodeApiKey

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety

fn from_unknown(value: JsUnknown) -> Result<Self, Error>

impl ObjectFinalize for NodeApiKey

fn finalize(self, env: Env) -> Result<(), Error>

impl ToNapiValue for NodeApiKey

unsafe fn to_napi_value(env: napi_env, val: NodeApiKey) -> Result<napi_value>

Safety

impl TypeName for &NodeApiKey

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &mut NodeApiKey

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for NodeApiKey

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for &NodeApiKey

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety

impl ValidateNapiValue for &mut NodeApiKey

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety