Home Reference Source
import SFile from 'senkowsh/src/senko/SFile.js'
public class | source

SFile

ファイル/フォルダ/URLを扱うクラス

Static Method Summary

Static Public Methods
public static

テンポラリフォルダ内の適当なファイル名を取得

public static

createXMLHttpRequest(): XMLHttpRequest

XMLHttpRequestを作成

public static

カレントディレクトリを取得

public static

カレントディレクトリを設定

Constructor Summary

Public Constructor
public

constructor(pathname: string | SFile)

初期化

Member Summary

Private Members
private

fso: any

private
private

Method Summary

Public Methods
public

copy(file_obj: string | SFile): boolean

ファイルのコピー

public

each(func: function(prm1: SFile): boolean): boolean

フォルダの中のフォルダとファイルに対して指定した関数を実行する

public

ファイルが存在するか

public

絶対パスを取得

public

サブフォルダの中まで探索して全てのファイルとフォルダを取得

public

バイナリファイルを開く(激重)

public

拡張子(ドットを含まない)

public

配下のファイル名の一覧を取得

public

名前を取得

public

区切り文字と終端を正規化した文字列を取得

public

親フォルダの絶対パス

public

親フォルダ

public

配下のサブフォルダ名の一覧を取得

public

テキストファイルを開く

public

絶対パスかどうか

public

フォルダかどうか

public

ファイルかどうか

public

隠しファイルかどうか

public

読み取り専用ファイルかどうか

public

更新日を取得

public

ファイルサイズ

public

list(): string[]

配下のファイル名とフォルダ名を取得

public

フォルダを作成

  • フォルダは1つのみ指定可能
  • すでにフォルダがある場合はエラーを返す。
public

フォルダを作成

  • 作成したいフォルダを続けて記載が可能
  • フォルダがない場合はフォルダを作成していく
public

move(file_obj: string | SFile): boolean

ファイルの移動

public

remove(is_force: boolean): boolean

ファイルの削除(ゴミ箱には入りません)

public

renameTo(file_obj: string | SFile): boolean

ファイル名を変更

public

run(style: number, is_wait: boolean): void

実行ファイルを起動する

public

searchFile(file_obj: string | SFile | function(prm1: string, prm2: string): boolean): SFile | null

指定した条件にあうファイルを探す 関数を指定する場合は、ファイル名とフルパスが引数に渡されます

public

バイナリファイルを保存(激重)

public

setHidden(is_hidden: boolean, is_allfiles: boolean): boolean

隠しファイルかどうかを設定する

public

更新日を設定(ファイルのみ対応)

public

setReadOnly(is_readonly: boolean, is_allfiles: boolean): boolean

読み取り専用ファイルかどうかを設定する

public

setTextFile(text: string, charset: string, newline: string, issetBOM: boolean): boolean

テキストファイルを保存

public

文字列化

public

1行書き加える

Static Public Methods

public static createTempFile(): SFile source

テンポラリフォルダ内の適当なファイル名を取得

Return:

SFile

public static createXMLHttpRequest(): XMLHttpRequest source

XMLHttpRequestを作成

Return:

XMLHttpRequest

public static getCurrentDirectory(): SFile source

カレントディレクトリを取得

Return:

SFile

public static setCurrentDirectory(file_obj: string | SFile) source

カレントディレクトリを設定

Params:

NameTypeAttributeDescription
file_obj string | SFile

Public Constructors

public constructor(pathname: string | SFile) source

初期化

Params:

NameTypeAttributeDescription
pathname string | SFile

ファイル名/フォルダ名/URLアドレス

Private Members

private fso: any source

private is_http: boolean source

private pathname: string source

Public Methods

public copy(file_obj: string | SFile): boolean source

ファイルのコピー

Params:

NameTypeAttributeDescription
file_obj string | SFile

Return:

boolean

public each(func: function(prm1: SFile): boolean): boolean source

フォルダの中のフォルダとファイルに対して指定した関数を実行する

Params:

NameTypeAttributeDescription
func function(prm1: SFile): boolean

戻り値がfalseで処理を終了。

Return:

boolean

result

public exists(): boolean source

ファイルが存在するか

Return:

boolean

public getAbsolutePath(): string source

絶対パスを取得

Return:

string

public getAllFiles(): SFile[] source

サブフォルダの中まで探索して全てのファイルとフォルダを取得

Return:

SFile[]

public getBinaryFile(): number[] source

バイナリファイルを開く(激重)

Return:

number[]

public getExtensionName(): string source

拡張子(ドットを含まない)

Return:

string

public getFiles(): string[] source

配下のファイル名の一覧を取得

Return:

string[]

public getName(): string source

名前を取得

Return:

string

public getNormalizedPathName(): string source

区切り文字と終端を正規化した文字列を取得

Return:

string

public getParent(): string source

親フォルダの絶対パス

Return:

string

public getParentFile(): SFile source

親フォルダ

Return:

SFile

public getSubFolders(): string[] source

配下のサブフォルダ名の一覧を取得

Return:

string[]

public getTextFile(charset: string): string source

テキストファイルを開く

Params:

NameTypeAttributeDescription
charset string
  • optional
  • default: "_autodetect_all"

文字コード

Return:

string

public isAbsolute(): boolean source

絶対パスかどうか

Return:

boolean

public isDirectory(): boolean source

フォルダかどうか

Return:

boolean

public isFile(): boolean source

ファイルかどうか

Return:

boolean

public isHidden(): boolean source

隠しファイルかどうか

Return:

boolean

public isReadOnly(): boolean source

読み取り専用ファイルかどうか

Return:

boolean

public lastModified(): Date source

更新日を取得

Return:

Date

public length(): number source

ファイルサイズ

Return:

number

public list(): string[] source

配下のファイル名とフォルダ名を取得

Return:

string[]

public mkdir(): boolean source

フォルダを作成

  • フォルダは1つのみ指定可能
  • すでにフォルダがある場合はエラーを返す。

Return:

boolean

public mkdirs(): boolean source

フォルダを作成

  • 作成したいフォルダを続けて記載が可能
  • フォルダがない場合はフォルダを作成していく

Return:

boolean

public move(file_obj: string | SFile): boolean source

ファイルの移動

Params:

NameTypeAttributeDescription
file_obj string | SFile

Return:

boolean

public remove(is_force: boolean): boolean source

ファイルの削除(ゴミ箱には入りません)

Params:

NameTypeAttributeDescription
is_force boolean
  • optional
  • default: false

読み取り専用でも削除する

Return:

boolean

public renameTo(file_obj: string | SFile): boolean source

ファイル名を変更

Params:

NameTypeAttributeDescription
file_obj string | SFile

Return:

boolean

public run(style: number, is_wait: boolean): void source

実行ファイルを起動する

Params:

NameTypeAttributeDescription
style number
  • optional
  • default: 1

起動オプション

is_wait boolean
  • optional
  • default: false

プロセスが終了するまで待つ

Return:

void

public searchFile(file_obj: string | SFile | function(prm1: string, prm2: string): boolean): SFile | null source

指定した条件にあうファイルを探す 関数を指定する場合は、ファイル名とフルパスが引数に渡されます

Params:

NameTypeAttributeDescription
file_obj string | SFile | function(prm1: string, prm2: string): boolean

Return:

SFile | null

public setBinaryFile(array_: number[]): boolean source

バイナリファイルを保存(激重)

Params:

NameTypeAttributeDescription
array_ number[]

Return:

boolean

public setHidden(is_hidden: boolean, is_allfiles: boolean): boolean source

隠しファイルかどうかを設定する

Params:

NameTypeAttributeDescription
is_hidden boolean
is_allfiles boolean
  • optional
  • default: false

Return:

boolean

public setLastModified(date: Date): boolean source

更新日を設定(ファイルのみ対応)

Params:

NameTypeAttributeDescription
date Date

Return:

boolean

public setReadOnly(is_readonly: boolean, is_allfiles: boolean): boolean source

読み取り専用ファイルかどうかを設定する

Params:

NameTypeAttributeDescription
is_readonly boolean
is_allfiles boolean
  • optional
  • default: false

Return:

boolean

public setTextFile(text: string, charset: string, newline: string, issetBOM: boolean): boolean source

テキストファイルを保存

Params:

NameTypeAttributeDescription
text string
charset string
  • optional
  • default: "utf-8"

文字コード

newline string
  • optional
  • default: "\n"

改行コード

issetBOM boolean
  • optional
  • default: true

BOMの有無(utf-8のみ有効 )

Return:

boolean

public toString(): string source

文字列化

Return:

string

public writeLine(text: string): boolean source

1行書き加える

Params:

NameTypeAttributeDescription
text string

Return:

boolean