Node.js

Read the Target of a Symbolic Link

Demonstrates the Chilkat SFtp.ReadLink method, which returns the target path stored in a remote symbolic link. The only argument is the link path. The example then resolves the target to an absolute path with RealPath.

Background: ReadLink returns the raw string stored in the link exactly as it was created — which may be relative, absolute, or even dangling — without resolving it. That distinction matters: to learn where a link actually leads you follow it with RealPath, which canonicalizes the path on the server. Reading the raw target is the right choice when you need to inspect or preserve the link itself rather than its destination.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates the SFtp.ReadLink method, which returns the target path stored in a remote
    //  symbolic link.  The only argument is the link path.

    var sftp = new chilkat.SFtp();

    //  Connect, authenticate, and initialize the SFTP subsystem.
    var port = 22;
    success = sftp.Connect("sftp.example.com",port);
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    var password = "mySshPassword";

    success = sftp.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    success = sftp.InitializeSftp();
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    //  Read the target of a symbolic link.  The returned value is the raw target string stored in
    //  the link; it is not canonicalized and can be relative or absolute.
    var target = sftp.ReadLink("subdir/latest.log");
    if (sftp.LastMethodSuccess == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("The link points to: " + target);

    //  To resolve it to an absolute path, pass it to RealPath.
    var absTarget = sftp.RealPath(target,"");
    if (sftp.LastMethodSuccess == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Absolute target: " + absTarget);

    sftp.Disconnect();

}

chilkatExample();