Skip to main content

TypeScript shorten generic function call

I am using Sequelize 6.6.5 with TypeScript 4.4.3 on Node 14.17.6

db/models/User.ts (only relevant parts)

import {
  Sequelize,
  Model,
  DataTypes,
  Optional,
  ModelAttributeColumnOptions,
} from 'sequelize';

import { FlagPositions, Flags } from '../types';

export interface IUserFlags {
  isDev: boolean;
  isAdmin: boolean;
  isMod: boolean;
}

export const flagPositions: FlagPositions<IUserFlags> = {
  isDev: 0,
  isAdmin: 1,
  isMod: 2,
};

export interface IUserAttributes extends Flags, IUserFlags {
  id: number;

  name: string;

  email: string;

  // ...
}

export interface IUserCreationAttributes
  extends Optional<
    IUserAttributes,
    | 'id'
    | 'flags'
    | 'isDev'
    | 'isAdmin'
    | 'isMod'
  > {}

export class User
  extends Model<IUserAttributes, IUserCreationAttributes>
  implements IUserAttributes
{
  public id!: number;

  public name!: string;

  public email!: string;

  public flags!: number;

  public isDev!: boolean;
  public isAdmin!: boolean;
  public isMod!: boolean;

  // ...
}

export function init(sequelize: Sequelize): void {
  User.init(
    {
      id: {
        type: DataTypes.INTEGER,
        primaryKey: true,
        autoIncrement: true,
        unique: true,
      },
      name: {
        type: DataTypes.STRING,
        allowNull: false,
        unique: true,
      },
      email: {
        type: DataTypes.STRING,
        allowNull: false,
        unique: true,
      },
      // ...
      flags: {
        type: DataTypes.INTEGER,
        defaultValue: 0,
      },
      isDev: {
        type: DataTypes.VIRTUAL,
        get(): boolean {
          return !!((this.flags >> flagPositions.isDev) & 1);
        },
        set(value: boolean): void {
          const flags = this.getDataValue('flags');

          const mask = 1 << flagPositions.isDev;

          this.setDataValue('flags', value ? flags | mask : flags & ~mask);
        },
      },
      isAdmin: {
        type: DataTypes.VIRTUAL,
        get(): boolean {
          return !!((this.flags >> flagPositions.isAdmin) & 1);
        },
        set(value: boolean): void {
          const flags = this.getDataValue('flags');

          const mask = 1 << flagPositions.isAdmin;

          this.setDataValue('flags', value ? flags | mask : flags & ~mask);
        },
      },
      isMod: {
        type: DataTypes.VIRTUAL,
        get(): boolean {
          return !!((this.flags >> flagPositions.isMod) & 1);
        },
        set(value: boolean): void {
          const flags = this.getDataValue('flags');

          const mask = 1 << flagPositions.isMod;

          this.setDataValue('flags', value ? flags | mask : flags & ~mask);
        },
      },
    },
    { sequelize, tableName: 'users' },
  );
}

../types

interface Flags {
  flags: number;
}

type FlagPositions<F extends Record<keyof F, boolean>> = {
  [K in keyof F]: number;
};

As you can see, the code for the flag virtuals is basically duplicated (WET).

I wanted to have something like this

isDev: createFlagVirtual<IUserFlags>(flagPositions, 'isDev');

After a long list of errors, I came up with

function createFlagVirtual<
  TModelAttributes extends Flags,
  TModelCreationAttributes extends Partial<TModelAttributes>,
  TModel extends Model<TModelAttributes, TModelCreationAttributes> &
    TModelAttributes,
  TFlags extends Record<keyof TFlags, boolean>,
  TFlag extends keyof TFlags = keyof TFlags,
>(
  positions: FlagPositions<TFlags>,
  flag: TFlag,
): ModelAttributeColumnOptions<TModel> {
  return {
    type: DataTypes.VIRTUAL,
    get(): boolean {
      return !!((this.flags >> positions[flag]) & 1);
    },
    set(value: boolean): void {
      const flags = this.getDataValue('flags');

      const mask = 1 << positions[flag];

      this.setDataValue('flags', value ? flags | mask : flags & ~mask);
    },
  };
}

Wondering how I call it?:

createFlagVirtual<IUserAttributes, IUserCreationAttributes, User, IUserFlags>(
  flagPositions,
  'isMod',
);

Yah; not so DRY.

On top of which, typescript still has no idea that 'flags' can be passed to this.getDataValue, atleast according to vscode intellisense. However, it knows that directly accessing this.flags is a number.

I want to know how to shorten the call to createFlagVirtual so that the following works createFlagVirtual<IUserFlags>(flagPositions, 'isDev');. TypeScript should know what can be passed to the second argument, aka a keyof IUserFlags. Also, in the implementation, this.getDataValue should know that 'flags' is a value.

Via Active questions tagged javascript - Stack Overflow https://ift.tt/2FdjaAW

Comments

Popular posts from this blog

Confusion between commands.Bot and discord.Client | Which one should I use?

Whenever you look at YouTube tutorials or code from this website there is a real variation. Some developers use client = discord.Client(intents=intents) while the others use bot = commands.Bot(command_prefix="something", intents=intents) . Now I know slightly about the difference but I get errors from different places from my code when I use either of them and its confusing. Especially since there has a few changes over the years in discord.py it is hard to find the real difference. I tried sticking to discord.Client then I found that there are more features in commands.Bot . Then I found errors when using commands.Bot . An example of this is: When I try to use commands.Bot client = commands.Bot(command_prefix=">",intents=intents) async def load(): for filename in os.listdir("./Cogs"): if filename.endswith(".py"): client.load_extension(f"Cogs.{filename[:-3]}") The above doesnt giveany response from my Cogs ...

How to show number of registered users in Laravel based on usertype?

i'm trying to display data from the database in the admin dashboard i used this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count(); echo $users; ?> and i have successfully get the correct data from the database but what if i want to display a specific data for example in this user table there is "usertype" that specify if the user is normal user or admin i want to user the same code above but to display a specific usertype i tried this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count()->WHERE usertype =admin; echo $users; ?> but it didn't work, what am i doing wrong? source https://stackoverflow.com/questions/68199726/how-to-show-number-of-registered-users-in-laravel-based-on-usertype

Why is my reports service not connecting?

I am trying to pull some data from a Postgres database using Node.js and node-postures but I can't figure out why my service isn't connecting. my routes/index.js file: const express = require('express'); const router = express.Router(); const ordersCountController = require('../controllers/ordersCountController'); const ordersController = require('../controllers/ordersController'); const weeklyReportsController = require('../controllers/weeklyReportsController'); router.get('/orders_count', ordersCountController); router.get('/orders', ordersController); router.get('/weekly_reports', weeklyReportsController); module.exports = router; My controllers/weeklyReportsController.js file: const weeklyReportsService = require('../services/weeklyReportsService'); const weeklyReportsController = async (req, res) => { try { const data = await weeklyReportsService; res.json({data}) console...