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

ectomapper

v1.0.2

Published

A lightweight, flexible, and type-safe AutoMapper utility for TypeScript, allowing you to easily map between different object types.

Downloads

27

Readme

ectomapper

CI

A lightweight, flexible, and type-safe AutoMapper utility for TypeScript, allowing you to easily map between different object types.

Features

  • Type-safe mappings: Leverage TypeScript generics to ensure type safety when mapping between object types.
  • Flexible configuration: Define custom mappings between any two types using string keys.

Installation

To install the package:

npm i ectomapper

Usage

Basic example

Here’s how to create and use an AutoMapper in your TypeScript project:

import { createAutoMapper } from 'ectomapper'

// Define your source and destination types
interface SourceType {
  id: number
  name: string
}

interface DestinationType {
  id: number
  fullName: string
}

// Create an instance of AutoMapper
const autoMapper = createAutoMapper()

// Define a map between SourceType and DestinationType
autoMapper.createMap<SourceType, DestinationType>(
  'SourceType',
  'DestinationType',
  (source) => ({
    id: source.id,
    fullName: source.name,
  }),
)

// Use the map to transform an object
const source: SourceType = { id: 1, name: 'John Doe' }
const destination = autoMapper.map<SourceType, DestinationType>(
  source,
  'SourceType',
  'DestinationType',
)

console.log(destination) // Output: { id: 1, fullName: 'John Doe' }

Advanced example

You can define multiple mappings for different types:

interface UserDTO {
  userId: number
  username: string
}

interface User {
  id: number
  name: string
}

// Create mappings
autoMapper.createMap<UserDTO, User>('UserDTO', 'User', (source) => ({
  id: source.userId,
  name: source.username,
}))

autoMapper.createMap<User, UserDTO>('User', 'UserDTO', (source) => ({
  userId: source.id,
  username: source.name,
}))

// Map between UserDTO and User
const userDTO: UserDTO = { userId: 42, username: 'johndoe' }
const user = autoMapper.map<UserDTO, User>(userDTO, 'UserDTO', 'User')

console.log(user) // Output: { id: 42, name: 'johndoe' }

Error Handling

If you attempt to map an object without a corresponding mapping, an error will be thrown:

try {
  const unknownMapping = autoMapper.map<SourceType, DestinationType>(
    source,
    'UnknownSource',
    'UnknownDestination',
  )
} catch (error) {
  console.error(error.message) // Output: No mapping found for key: UnknownSource->UnknownDestination
}

API

createMap

createMap<TSource, TDestination>(
  sourceKey: string,
  destinationKey: string,
  mappingFunction: MapperFunction<TSource, TDestination>
): void

Defines a mapping between two types using the provided string keys.

  • sourceKey: A string that identifies the source type.
  • destinationKey: A string that identifies the destination type.
  • mappingFunction: A function that defines how to map from the source type to the destination type.

map

map<TSource, TDestination>(
  source: TSource,
  sourceKey: string,
  destinationKey: string
): TDestination

Maps an object from the source type to the destination type using the defined mapping.

  • source: The object to map.
  • sourceKey: The key identifying the source type.
  • destinationKey: The key identifying the destination type.
  • Returns: The mapped object of the destination type.

Contributing

Contributions are welcome! Please submit issues and pull requests to help improve the package.

License

This project is licensed under the terms of the MIT License.