npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@coder-ka/named-parameter

v0.0.5

Published

NamedParameter is a small library that simply converts SQL with named parameters to those labeled with `?`.

Downloads

122

Readme

NamedParameter

NamedParameter is a small library that simply converts SQL with named parameters to those labeled with ?.

Installation

npm install --save @coder-ka/named-parameter

Usage

The following example is the simplest one.

import { replace } from "@coder-ka/named-parameter";

const { sql, params } = replace("select * from table where col=:value", {
  value: "val1",
});

console.log(sql);
// Output:
// select * from table where col=?
console.log(params);
// Output:
// ['val1']

It simply replaces the word :value with `?' and create parameter array to bind.

If you want to bind a parameter to multiple placeholders, you can do so.

import { replace } from "@coder-ka/named-parameter";

const { sql, params } = replace(
  "select * from table where col1=:value and col2=:value",
  {
    value: "val1",
  }
);

console.log(sql);
// Output:
// select * from table where col1=? and col2=?
console.log(params);
// Output:
// ['val1', 'val1']

Binding arrays

If you specify the value of an array as a parameter, the number of items in the array will be stored in the ? concatenated with commas will be generated in parentheses.

import { replace } from "@coder-ka/named-parameter";

const { sql, params } = replace(
  "select * from table where col in :values",
  {
    values: ["val1", "val2", "val3"],
  }
);

console.log(sql);
// Output:
// select * from table where col in (?,?,?)
console.log(params);
// Output:
// ['val1', 'val2', 'val3']

Options

You can create a custom replace function by the createReplace method.

The type of Options is below.

type Option = {
  // the starting character for named parameter.
  // default: ':'
  start: string;
  // function that create placeholder
  placeholder: (index: number) => string;
}

example:

import { createReplace } from "@coder-ka/named-parameter";

const replace = createReplace({
  // change starting character
  start: '@',
  // change placeholder string
  placeholder: (index) => `$${index}`
})

const { sql, params } = replace("select * from table where col=@value1 or col=@value2", {
  value1: "val1",
  value2: "val2",
});

console.log(sql);
// Output:
// select * from table where col=$1 or col=$2
console.log(params);
// Output:
// ['val1', 'val2']