Typescriptで辞書を宣言して初期化する


248

次のコードを考える

interface IPerson {
   firstName: string;
   lastName: string;
}

var persons: { [id: string]: IPerson; } = {
   "p1": { firstName: "F1", lastName: "L1" },
   "p2": { firstName: "F2" }
};

初期化が拒否されないのはなぜですか?結局、2番目のオブジェクトには「lastName」プロパティがありません。


11
注:これは修正されています(正確なTSバージョンは不明)。私は、あなたが期待するように、VSにこれらのエラーを取得: Index signatures are incompatible. Type '{ firstName: string; }' is not assignable to type 'IPerson'. Property 'lastName' is missing in type '{ firstName: string; }'.
Simon_Weaver

回答:


289

編集:これは、最新のTSバージョンで修正されています。OPの投稿に対する@Simon_Weaverのコメントを引用:

注:これは修正されています(正確なTSバージョンは不明)。あなたが期待するように、私はVSでこれらのエラーを受け取ります:Index signatures are incompatible. Type '{ firstName: string; }' is not assignable to type 'IPerson'. Property 'lastName' is missing in type '{ firstName: string; }'.


どうやらこれは、宣言時に初期データを渡すときに機能しません。これはTypeScriptのバグだと思いますので、プロジェクトサイトで発生させてください。

次のように、宣言と初期化で例を分割することにより、型付き辞書を利用できます。

var persons: { [id: string] : IPerson; } = {};
persons["p1"] = { firstName: "F1", lastName: "L1" };
persons["p2"] = { firstName: "F2" }; // will result in an error

3
なぜidシンボルが必要なのですか?必要ないようです。
kiewic

4
idシンボルを使用して、辞書のキーのタイプを宣言することができます。:上記の宣言を使用すると、次の操作を行うことができませんでしたpersons[1] = { firstName: 'F1', lastName: 'L1' }
thomaux

2
何らかの理由で常にこの構文を忘れてください!
eddiewould 2018

12
idシンボルには任意の名前を付けることができ、コードを読みやすくするように設計されています。例えば { [username: string] : IPerson; }
ガイ・パーク

1
@Robouste LodashのfindKeyメソッドを使用するか、ネイティブソリューションを使用する場合は、Object.entriesに基づいてビルドできます。キーの完全なリストを取得したい場合は、Object.keys
thomauxをご覧ください。'

82

typescriptでディクショナリオブジェクトを使用するには、次のようにインターフェイスを使用できます。

interface Dictionary<T> {
    [Key: string]: T;
}

そして、これをクラスプロパティタイプに使用します。

export class SearchParameters {
    SearchFor: Dictionary<string> = {};
}

このクラスを使用して初期化するには、

getUsers(): Observable<any> {
        var searchParams = new SearchParameters();
        searchParams.SearchFor['userId'] = '1';
        searchParams.SearchFor['userName'] = 'xyz';

        return this.http.post(searchParams, 'users/search')
            .map(res => {
                return res;
            })
            .catch(this.handleError.bind(this));
    }

60

初期化の型チェックエラーはTypeScriptのバグであるというthomauxに同意します。ただし、正しい型チェックを使用して単一のステートメントでディクショナリを宣言および初期化する方法を探していました。この実装は長くなりますが、containsKey(key: string)and remove(key: string)メソッドなどの追加機能が追加されます。ジェネリックが0.9リリースで利用可能になれば、これは簡略化できると思います。

最初に、基本ディクショナリクラスとインターフェイスを宣言します。クラスがインデクサーを実装できないため、このインターフェイスはインデクサーに必要です。

interface IDictionary {
    add(key: string, value: any): void;
    remove(key: string): void;
    containsKey(key: string): bool;
    keys(): string[];
    values(): any[];
}

class Dictionary {

    _keys: string[] = new string[];
    _values: any[] = new any[];

    constructor(init: { key: string; value: any; }[]) {

        for (var x = 0; x < init.length; x++) {
            this[init[x].key] = init[x].value;
            this._keys.push(init[x].key);
            this._values.push(init[x].value);
        }
    }

    add(key: string, value: any) {
        this[key] = value;
        this._keys.push(key);
        this._values.push(value);
    }

    remove(key: string) {
        var index = this._keys.indexOf(key, 0);
        this._keys.splice(index, 1);
        this._values.splice(index, 1);

        delete this[key];
    }

    keys(): string[] {
        return this._keys;
    }

    values(): any[] {
        return this._values;
    }

    containsKey(key: string) {
        if (typeof this[key] === "undefined") {
            return false;
        }

        return true;
    }

    toLookup(): IDictionary {
        return this;
    }
}

次に、Person固有の型とDictionary / Dictionaryインターフェースを宣言します。PersonDictionaryで、どのようにオーバーライドvalues()toLookup()て正しいタイプを返すかを確認します。

interface IPerson {
    firstName: string;
    lastName: string;
}

interface IPersonDictionary extends IDictionary {
    [index: string]: IPerson;
    values(): IPerson[];
}

class PersonDictionary extends Dictionary {
    constructor(init: { key: string; value: IPerson; }[]) {
        super(init);
    }

    values(): IPerson[]{
        return this._values;
    }

    toLookup(): IPersonDictionary {
        return this;
    }
}

そして、ここに簡単な初期化と使用例があります:

var persons = new PersonDictionary([
    { key: "p1", value: { firstName: "F1", lastName: "L2" } },
    { key: "p2", value: { firstName: "F2", lastName: "L2" } },
    { key: "p3", value: { firstName: "F3", lastName: "L3" } }
]).toLookup();


alert(persons["p1"].firstName + " " + persons["p1"].lastName);
// alert: F1 L2

persons.remove("p2");

if (!persons.containsKey("p2")) {
    alert("Key no longer exists");
    // alert: Key no longer exists
}

alert(persons.keys().join(", "));
// alert: p1, p3

非常に役立つサンプルコード。IPersonへの参照があるため、「インターフェイスIDictionary」には小さなタイプミスが含まれています。
mgs 2013

要素数も実装するとよいでしょう
nurettin '11 / 11/14

@dmck宣言containsKey(key: string): bool;TypeScript 1.5.0-betaでは機能しません。に変更する必要がありますcontainsKey(key: string): boolean;
Amarjeet Singh 2015

1
なぜジェネリック型をデルケアしないのですか?Dictionary <T>の場合、PersonDictionaryクラスを作成する必要はありません。次のように宣言します。varpersons = new Dictionary <IPerson>();
Benoit

1
私はそのような一般的な辞書を効果的に使用しました。私はここでそれを見つけた:fabiolandoni.ch/...
CAK2

5

これは@dmckからインスピレーションを得たより一般的なディクショナリ実装です

    interface IDictionary<T> {
      add(key: string, value: T): void;
      remove(key: string): void;
      containsKey(key: string): boolean;
      keys(): string[];
      values(): T[];
    }

    class Dictionary<T> implements IDictionary<T> {

      _keys: string[] = [];
      _values: T[] = [];

      constructor(init?: { key: string; value: T; }[]) {
        if (init) {
          for (var x = 0; x < init.length; x++) {
            this[init[x].key] = init[x].value;
            this._keys.push(init[x].key);
            this._values.push(init[x].value);
          }
        }
      }

      add(key: string, value: T) {
        this[key] = value;
        this._keys.push(key);
        this._values.push(value);
      }

      remove(key: string) {
        var index = this._keys.indexOf(key, 0);
        this._keys.splice(index, 1);
        this._values.splice(index, 1);

        delete this[key];
      }

      keys(): string[] {
        return this._keys;
      }

      values(): T[] {
        return this._values;
      }

      containsKey(key: string) {
        if (typeof this[key] === "undefined") {
          return false;
        }

        return true;
      }

      toLookup(): IDictionary<T> {
        return this;
      }
    }

3

プロパティを無視する場合は、疑問符を追加してオプションとしてマークします。

interface IPerson {
    firstName: string;
    lastName?: string;
}

1
与えられたコードは、最後の名前を提供せずにコンパイルした理由を質問の全体のポイントは...ある
ピエールArlaud

-1

現在、typescriptで強く型付けされたクエリ可能なコレクションを提供するライブラリがあります。

これらのコレクションは次のとおりです。

  • リスト
  • 辞書

ライブラリはts-generic-collections-linqと呼ばれます

GitHubのソースコード:

https://github.com/VeritasSoftware/ts-generic-collections

NPM:

https://www.npmjs.com/package/ts-generic-collections-linq

このライブラリを使用すると、コレクション(などList<T>)を作成して、以下に示すようにクエリを実行できます。

    let owners = new List<Owner>();

    let owner = new Owner();
    owner.id = 1;
    owner.name = "John Doe";
    owners.add(owner);

    owner = new Owner();
    owner.id = 2;
    owner.name = "Jane Doe";
    owners.add(owner);    

    let pets = new List<Pet>();

    let pet = new Pet();
    pet.ownerId = 2;
    pet.name = "Sam";
    pet.sex = Sex.M;

    pets.add(pet);

    pet = new Pet();
    pet.ownerId = 1;
    pet.name = "Jenny";
    pet.sex = Sex.F;

    pets.add(pet);

    //query to get owners by the sex/gender of their pets
    let ownersByPetSex = owners.join(pets, owner => owner.id, pet => pet.ownerId, (x, y) => new OwnerPet(x,y))
                               .groupBy(x => [x.pet.sex])
                               .select(x =>  new OwnersByPetSex(x.groups[0], x.list.select(x => x.owner)));

    expect(ownersByPetSex.toArray().length === 2).toBeTruthy();

    expect(ownersByPetSex.toArray()[0].sex == Sex.F).toBeTruthy();
    expect(ownersByPetSex.toArray()[0].owners.length === 1).toBeTruthy();
    expect(ownersByPetSex.toArray()[0].owners.toArray()[0].name == "John Doe").toBeTruthy();

    expect(ownersByPetSex.toArray()[1].sex == Sex.M).toBeTruthy();
    expect(ownersByPetSex.toArray()[1].owners.length == 1).toBeTruthy();
    expect(ownersByPetSex.toArray()[1].owners.toArray()[0].name == "Jane Doe").toBeTruthy();

このためのnpmパッケージが見つかりません
Harry

1
@Harry - NPMパッケージは、 "TS-ジェネリック・コレクション- LINQ"と呼ばれている
アデ
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.