Object mapping, and more, for Redis and Node.js. Written in TypeScript. 

simonprickett

guyroyse

justincastilla

redis-om

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

import { createClient, createCluster, RediSearchSchema, SearchOptions } from 'redis';

/** The Symbol used to access the entity ID of an {@link Entity}. */

/** The Symbol used to access the keyname of an {@link Entity}. */

declare const EntityKeyName: unique symbol;

/** Defines the objects returned from calls to {@link Repository | repositories }. */

    /** The unique ID of the {@link Entity}. Access using the {@link EntityId} Symbol. */

    /** The key the {@link Entity} is stored under inside of Redis. Access using the {@link EntityKeyName} Symbol. */

/** The free-form data associated with an {@link Entity}. */

    [key: string]: EntityDataValue | EntityData | Array<EntityDataValue | EntityData>;

/** Valid types for values in an {@link Entity}. */

/** Defines a point on the globe using longitude and latitude. */

/** Valid field types for a {@link FieldDefinition}. */

/** All configuration properties that any field might have, regardless of type. */

    /** The type of the field (i.e. string, number, boolean, etc.) */

     * The default field name in Redis is the property name defined in the

     * {@link SchemaDefinition}. Overrides the field name for a Hash to this

     * value or in the case of JSON documents, sets the JSONPath to this

     * value preceded by `$.`. Overridden by {@link field} and/or {@link path}

     * Is this field indexed and thus searchable with Redis OM. Defaults

     * The field name used to store this in a Redis Hash. Defaults to the

     * name used in the {@link SchemaDefinition} or the {@link alias}

     * The JSONPath expression this field references. Used only by search

     * and only for JSON documents. Defaults to the name used in the

     * {@link SchemaDefinition} or the {@link alias} property prefixed

    /** Enables sorting by this field. */

    /** Is the original case of this field indexed with Redis OM. Defaults to false. */

    /** Is this (sortable) field normalized when indexed. Defaults to true. */

     * Due to how RediSearch works, strings and arrays are sometimes stored the same in Redis, as a

     * simple string. This is the separator used to split those strings when it is an array. If your

     * StringField contains this separator, this can cause problems. You can change it here to avoid

     * Enables setting the phonetic matcher to use, supported matchers are:

     * dm:en - Double Metaphone for English

     * dm:fr - Double Metaphone for French

     * dm:pt - Double Metaphone for Portuguese

     * dm:es - Double Metaphone for Spanish

    matcher?: 'dm:en' | 'dm:fr' | 'dm:pt' | 'dm:es';

    /** Is word stemming applied to this field with Redis OM. Defaults to true. */

    /** Enables setting the weight to apply to a text field */

/** The configuration properties that all fields have in common. */

type CommonFieldDefinition = Pick<AllFieldDefinition, "type" | "alias" | "indexed" | "field" | "path">;

} & CommonFieldDefinition & Pick<AllFieldDefinition, "sortable">;

    protected escapePunctuation(value: string): string;

    protected escapePunctuationAndSpaces(value: string): string;

 * A function that takes a {@link Search} and returns a {@link Search}. Used in nested queries.

 * @template TEntity The type of {@link Entity} being sought.

type SubSearchFunction = (search: Search) => Search;

 * Abstract base class for {@link Search} and {@link RawSearch} that

 * contains methods to return search results.

    constructor(schema: Schema, client: Client);

     * Applies an ascending sort to the query.

     * @param field The field to sort by.

    sortAscending(field: string): AbstractSearch;

     * Alias for {@link Search.sortDescending}.

    sortDesc(field: string): AbstractSearch;

     * Applies a descending sort to the query.

    sortDescending(field: string): AbstractSearch;

     * Alias for {@link Search.sortAscending}.

    sortAsc(field: string): AbstractSearch;

       * @param field The field to sort by.

       * @param order The order of returned {@link Entity | Entities} Defaults to `ASC` (ascending) if not specified

    sortBy(fieldName: string, order?: 'ASC' | 'DESC'): AbstractSearch;

     * Finds the {@link Entity} with the minimal value for a field.

     * @param field The field with the minimal value.

     * @returns The {@link Entity} with the minimal value

    min(field: string): Promise<Entity | null>;

     * Finds the entity ID with the minimal value for a field.

     * @returns The entity ID with the minimal value

    minId(field: string): Promise<string | null>;

     * Finds the key name in Redis with the minimal value for a field.

     * @returns The key name with the minimal value

    minKey(field: string): Promise<string | null>;

     * Finds the {@link Entity} with the maximal value for a field.

     * @param field The field with the maximal value.

     * @returns The entity ID {@link Entity} with the maximal value

    max(field: string): Promise<Entity | null>;

     * Finds the entity ID with the maximal value for a field.

     * @returns The entity ID with the maximal value

    maxId(field: string): Promise<string | null>;

     * Finds the key name in Redis with the maximal value for a field.

     * @returns The key name with the maximal value

    maxKey(field: string): Promise<string | null>;

     * Returns the number of {@link Entity | Entities} that match this query.

     * Returns a page of {@link Entity | Entities} that match this query.

     * @param offset The offset for where to start returning {@link Entity | Entities}.

     * @param count The number of {@link Entity | Entities} to return.

     * @returns An array of {@link Entity | Entities} matching the query.

var __getOwnPropDesc = Object.getOwnPropertyDescriptor;

var __getOwnPropNames = Object.getOwnPropertyNames;

var __getProtoOf = Object.getPrototypeOf;

var __hasOwnProp = Object.prototype.hasOwnProperty;

		@@ -666,2 +666,4 @@ import { createClient, createCluster, RediSearchSchema, SearchOptions } from 'redis';
		protected escapePunctuation(value: string): string;
		/** @internal */
		protected escapePunctuationAndSpaces(value: string): string;
		}
		@@ -668,0 +670,0 @@

		@@ -819,9 +819,13 @@ "use strict";
		const negationPortion = this.negated ? "-" : "";
		const fieldPortion = this.escapePunctuation(this.field.name);
		const fieldPortion = this.escapePunctuationAndSpaces(this.field.name);
		return `(${negationPortion}@${fieldPortion}:${valuePortion})`;
		}
		escapePunctuation(value) {
		const matchPunctuation = /[,.<>{}[\]"':;!@#$%^&()\-+=~\|/\\ ]/g;
		const matchPunctuation = /[,.?<>{}[\]"':;!@#$%^&()\-+=~\|/\\]/g;
		return value.replace(matchPunctuation, "\\$&");
		}
		escapePunctuationAndSpaces(value) {
		const matchPunctuation = /[,.?<>{}[\]"':;!@#$%^&()\-+=~\|/\\ ]/g;
		return value.replace(matchPunctuation, "\\$&");
		}
		};
		@@ -847,4 +851,3 @@
		toString() {
		const matchPunctuation = /[,.<>{}[\]"':;!@#$%^&()\-+=~\| ]/g;
		const escapedValue = this.value.map((s) => s.replace(matchPunctuation, "\\$&")).join("\|");
		const escapedValue = this.value.map((s) => this.escapePunctuationAndSpaces(s)).join("\|");
		return this.buildQuery(`{${escapedValue}}`);
		@@ -1087,3 +1090,3 @@ }
		toString() {
		const escapedValue = this.escapePunctuation(this.value);
		const escapedValue = this.escapePunctuationAndSpaces(this.value);
		return this.buildQuery(`{${escapedValue}}`);
		@@ -1140,4 +1143,3 @@ }
		toString() {
		const matchPunctuation = /[,.<>{}[\]"':;!@#$%^&()\-+=~\|]/g;
		const escapedValue = this.value.replace(matchPunctuation, "\\$&");
		const escapedValue = this.escapePunctuation(this.value);
		if (this.exactValue) {
		@@ -1144,0 +1146,0 @@ return this.buildQuery(`"${escapedValue}"`);

		{
		"name": "redis-om",
		"version": "0.4.1",
		"version": "0.4.2",
		"description": "Object mapping, and more, for Redis and Node.js. Written in TypeScript.",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

Improved metrics