SassString

Sassの文字列型

階層

    • SassString

コンストラクタ

  • 新しい文字列を作成します。

    パラメータ

    • text: string

      文字列の内容。引用符付き文字列の場合、これはセマンティックな内容です。ソーステキストに記述されたエスケープシーケンスは、Unicode値に解決されます。ただし、引用符なしの文字列の場合、エスケープシーケンスはリテラルなバックスラッシュとして保持されます。

    • Optional options: {
          quotes?: boolean;
      }
      • Optional quotes?: boolean

        文字列が引用符で囲まれているかどうか。デフォルトはtrue

    戻り値 SassString

  • 空の文字列を作成します。

    パラメータ

    • Optional options: {
          quotes?: boolean;
      }
      • Optional quotes?: boolean

        文字列が引用符で囲まれているかどうか。デフォルトはtrue

    戻り値 SassString

アクセサ

  • asList(): List<Value>
  • リストとしてのこの値。

    すべてのSassScript値はリストとして使用できます。マップはペアのリストとしてカウントされ、その他のすべての値は単一値リストとしてカウントされます。

    List<Value> を返します。

    immutable パッケージ の変更不能な List です。

  • get hasBrackets(): boolean
  • この値がリストとして括弧を持っているかどうか。

    すべてのSassScript値はリストとして使用できます。マップはペアのリストとしてカウントされ、その他のすべての値は単一値リストとしてカウントされます。

    boolean を返します。

  • get hasQuotes(): boolean
  • この文字列が引用符を持っているかどうか。

    boolean を返します。

  • get isTruthy(): boolean
  • @if 文やその他のコンテキストで値がtrueとして扱われるかどうか。

    boolean を返します。

  • get realNull(): null | Value
  • これがsassNull の場合、JavaScriptのnull値を返し、それ以外の場合はthisを返します。

    null | Value を返します。

  • get sassLength(): number
  • Sassにおけるこの文字列の長さ。

    Sassは文字列をUnicodeコードポイントの連続として扱い、JavaScriptはUTF-16コードユニットの連続として扱います。例えば、文字U+1F60A SMILING FACE WITH SMILING EYES は単一のUnicodeコードポイントですが、UTF-16では2つのコードユニット(0xD83D0xDE0A)で表されます。そのため、JavaScriptでは"n😊b".length4を返し、Sassではstring.length("n😊b")3を返します。

    number を返します。

  • get separator(): ListSeparator
  • リストとしてのこの値のセパレータ。

    すべてのSassScript値はリストとして使用できます。マップはペアのリストとしてカウントされ、その他のすべての値は単一値リストとしてカウントされます。

    ListSeparator を返します。

  • get text(): string
  • 文字列の内容。

    引用符付きの文字列の場合、これはセマンティックな内容です。ソーステキストに記述されていたエスケープシーケンスは、そのUnicode値に解決されます。しかし、引用符なしの文字列の場合、エスケープシーケンスはリテラルのバックスラッシュとして保持されます。

    この違いにより、url\u28 http://example.com\u29などのエスケープを含む識別子と、url(http://example.com)などの識別子では無効な文字を含む引用符なしの文字列を区別できます。残念ながら、これはfoof\6F\6Fを同じ文字列とはみなさないことを意味します。

    string を返します。

メソッド

  • thisSassBooleanでない場合、例外をスローします。

    ⚠️ 注意!

    関数は一般的に、リテラルのブール値を要求するのではなく、isTruthy を使用する必要があります。

    パラメータ

    • Optional name: string

      引数から来た場合、thisが来た関数引数の名前($なし)。エラーレポートに使用されます。

    SassBoolean を返します。

  • thisSassColorでない場合、例外をスローします。

    パラメータ

    • Optional name: string

      引数から来た場合、thisが来た関数引数の名前($なし)。エラーレポートに使用されます。

    SassColor を返します。

  • thisSassFunctionでない場合、例外をスローします。

    パラメータ

    • Optional name: string

      引数から来た場合、thisが来た関数引数の名前($なし)。エラーレポートに使用されます。

    SassFunction クラスを返します。

  • this が SassMap クラスでない場合、エラーをスローします。

    パラメータ

    • Optional name: string

      引数から来た場合、thisが来た関数引数の名前($なし)。エラーレポートに使用されます。

    SassMap クラスを返します。

  • this が SassMixin クラスでない場合、エラーをスローします。

    パラメータ

    • Optional name: string

      引数から来た場合、thisが来た関数引数の名前($なし)。エラーレポートに使用されます。

    SassMixin クラスを返します。

  • this が SassNumber クラスでない場合、エラーをスローします。

    パラメータ

    • Optional name: string

      引数から来た場合、thisが来た関数引数の名前($なし)。エラーレポートに使用されます。

    SassNumber クラスを返します。

  • this が SassString クラスでない場合、エラーをスローします。

    パラメータ

    • Optional name: string

      引数から来た場合、thisが来た関数引数の名前($なし)。エラーレポートに使用されます。

    戻り値 SassString

  • thisother と同じ値を表すかどうかを返します。

    パラメータ

    • other: Value クラス

    boolean を返します。

  • リストとしてのこの値におけるインデックスindex の値を返します。index がこのリストに対して有効でない場合は undefined を返します。

    すべてのSassScript値はリストとして使用できます。マップはペアのリストとしてカウントされ、その他のすべての値は単一値リストとしてカウントされます。

    これは this.asList.get(index) の省略形ですが、場合によってはより効率的です。

    ⚠️ 注意!

    このメソッドは、immutable パッケージと同じインデックス付け規則を使用します。Sass とは異なり、最初の要素のインデックスは 0 ですが、Sass と同様に負の数はリストの末尾からインデックス付けされます。

    パラメータ

    • index: number

    undefined | Value クラスを返します。

  • ハッシュマップにthisを格納するために使用できるハッシュコードを返します。

    number を返します。

  • asListによって返されるリストに対するJavaScriptスタイルのインデックスにsassIndexを変換します。

    Sassのインデックスは1ベース、JavaScriptのインデックスは0ベースです。Sassのインデックスは、リストの末尾からインデックスを付けるために負の数にすることもできます。

    エラーをスローします

    sassIndex が数値でない場合、その数値が整数でない場合、またはその整数が asList に対して有効なインデックスでない場合。

    パラメータ

    • sassIndex: Value クラス

      リストとしてのこの値に対するSassスタイルのインデックス。

    • Optional name: string

      引数から来た場合の関数引数sassIndexの名前($なし)。エラー報告に使用されます。

    number を返します。

  • textに対するJavaScriptインデックスにsassIndexを変換します。

    Sassのインデックスは1ベース、JavaScriptのインデックスは0ベースです。Sassのインデックスは、文字列の末尾からインデックスを付けるために負の数にすることもできます。

    さらに、SassのインデックスはUnicodeコードポイントを参照しますが、JavaScriptの文字列インデックスはUTF-16コードユニットを参照します。たとえば、文字U+1F60A SMILING FACE WITH SMILING EYES は1つのUnicodeコードポイントですが、UTF-16では2つのコードユニット(0xD83D0xDE0A)で表されます。そのため、JavaScriptでは、"n😊b".charCodeAt(1)0xD83Dを返し、Sassではstring.slice("n😊b", 1, 1)"😊"を返します。

    この関数は、SassのコードポイントインデックスをJavaScriptのコードユニットインデックスに変換します。これは、textの長さに対してO(n)であることを意味します。

    エラーをスローします

    Error - sassIndexが数値でない場合、その数値が整数でない場合、またはその整数がこの文字列の有効なインデックスでない場合。

    パラメータ

    • sassIndex: Value クラス
    • Optional name: string

    number を返します。

  • これがマップとしてカウントされる場合(空のリストは空のマップとしてカウントされます)、thisをマップとして返します。そうでない場合はnullを返します。

    null | SassMap を返します。